box-openapi icon indicating copy to clipboard operation
box-openapi copied to clipboard

Missing Offset and Marker query param in certain operations

Open devdanco opened this issue 5 years ago • 0 comments

Offset and Marker query params

I found out that 4 endpoints does not have query params.

  1. files/:file_id/collaborations/ In the response we get offset parameter but we cannot set query param offset in order to paginate ?list_collaborations__get_files_id_collaborations.yml DOCS: get-files-id-collaborations

  2. folders/:folder_id/collaborations In the response we get offset and limit parameters but we cannot set query params offset and limit in order to paginate ? list_collaborations__get_folders_id_collaborations.yml DOCS: get-folders-id-collaborations

  3. folder_locks In the response we get next_marker but we cannot set query param marker in order to paginate ? folder_locks__get_folder_locks.yml DOCS: get-folder-locks

  4. metadata_templates In the response we get next_marker but we cannot set query param marker in order to paginate ? metadata_templates__get_metadata_templates.yml DOCS: get-metadata-templates

Current content

Specification does not take into account those query params for operations.

Expected content

I tested all endpoints with the listed query params and no issue was found. Therefore, endpoints with the mentioned parameters should be included in the docs and specification.

devdanco avatar Jan 18 '21 09:01 devdanco