You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Several endpoints in our Swagger documentation have issues with the "Try It Out" feature that prevent proper testing and misrepresent API requirements.
Issues
1. Accept Header Not Being Set
The Accept header can be set in the UI but is not actually included in the request when "Execute" is clicked, resulting in 400 (Bad Request) responses. This affects all endpoints:
GET /api/v21/collections
GET /api/v21/collections/{collectionId}
GET /api/v21/collections/{collectionsId}/manifest
GET /api/v21/collections/{collectionId}/objects
GET /api/v21/collections/{collectionId}/objects/{objectId}
GET /api/v21/collections/{collectionId}/objects/{objectId}/versions
2. Optional Parameters Marked as Required
Several query parameters are incorrectly marked as required in the Swagger documentation when they should be optional:
Collections Manifest endpoint:
match parameter is marked required but should be optional
GET /api/v21/collections/{collectionsId}/manifest
Objects endpoints:
Both added_after and match parameters are marked as required but should be optional
Affects:
GET /api/v21/collections/{collectionId}/objects
GET /api/v21/collections/{collectionId}/objects/{objectId}
GET /api/v21/collections/{collectionId}/objects/{objectId}/versions
Expected Behavior
Accept header set in the UI should be included in the actual request
Optional parameters should be marked as optional in the Swagger documentation
Current Behavior
Accept header is ignored when executing requests, causing 400 errors
Optional parameters are incorrectly marked as required, preventing valid API calls
Impact
These issues make it impossible to properly test the API through the Swagger UI and may mislead developers about the actual API requirements.
The text was updated successfully, but these errors were encountered:
Description
Several endpoints in our Swagger documentation have issues with the "Try It Out" feature that prevent proper testing and misrepresent API requirements.
Issues
1. Accept Header Not Being Set
The
Accept
header can be set in the UI but is not actually included in the request when "Execute" is clicked, resulting in 400 (Bad Request) responses. This affects all endpoints:2. Optional Parameters Marked as Required
Several query parameters are incorrectly marked as required in the Swagger documentation when they should be optional:
Collections Manifest endpoint:
match
parameter is marked required but should be optionalObjects endpoints:
added_after
andmatch
parameters are marked as required but should be optionalExpected Behavior
Current Behavior
Impact
These issues make it impossible to properly test the API through the Swagger UI and may mislead developers about the actual API requirements.
The text was updated successfully, but these errors were encountered: