box / box/box-openapi

Missing Offset and Marker query param in certain operations

Open
#132 0 comments 0 reactions 1 assignee Claimed by @cbetta View on GitHub
bug
Dominant language
No language data
Stars
101
Forks
89
Avg merge
30m
Merged PRs (30d)
3

Description

## Offset and Marker query params
I found out that 4 endpoints does not have query params.

1. [files/:file_id/collaborations/](https://api.box.com/2.0/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](https://github.com/box/box-openapi/blob/main/content/paths/list_collaborations__get_files_id_collaborations.yml)
DOCS: [get-files-id-collaborations](https://developer.box.com/reference/get-files-id-collaborations/)

2. [folders/:folder_id/collaborations](https://api.box.com/2.0/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](https://github.com/box/box-openapi/blob/main/content/paths/list_collaborations__get_folders_id_collaborations.yml)
DOCS: [get-folders-id-collaborations](https://developer.box.com/reference/get-folders-id-collaborations/)

3. [folder_locks](https://api.box.com/2.0/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](https://github.com/box/box-openapi/blob/main/content/paths/folder_locks__get_folder_locks.yml)
DOCS: [get-folder-locks](https://developer.box.com/reference/get-folder-locks/)

4. [metadata_templates](https://api.box.com/2.0/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](https://github.com/box/box-openapi/blob/main/content/paths/metadata_templates__get_metadata_templates.yml)
DOCS: [get-metadata-templates](https://developer.box.com/reference/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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.