Skip to content

Update GET /hotels/{hotelId}/reservations spec to reflect offset limit of 1000 #103

Description

@kitahashiryoichi

Hello,

I would like to request an update to the rsv.json specification regarding the offset parameter for the reservation collection endpoint.

Currently, the API has a hard limit where pagination is cut off after 1000 records, but this limitation is not explicitly defined in the OpenAPI specification. To improve developer experience and avoid confusion, please add the maximum validation and update the description.

Target File: rest-api-specs/property/rsv.json Endpoint: GET /hotels/{hotelId}/reservations

Proposed Changes:

Please update the offset parameter definition as follows (adding maximum and updating description):

{
  "name": "offset",
  "in": "query",
  "description": "Index of the first record to return in the result. \n\n**Note:** The maximum allowed offset is 1000. Any records beyond this limit are cut off and cannot be retrieved via pagination.",
  "required": false,
  "type": "integer",
  "maximum": 1000
}

Thank you.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions