Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Paging details in listing responses #77

Merged
merged 8 commits into from
Jun 12, 2024

Conversation

jackdos
Copy link
Collaborator

@jackdos jackdos commented May 8, 2024

Resolves Issue #21

@jackdos jackdos added the enhancement New feature or request label May 8, 2024
@jackdos jackdos added this to the v1.3.0 milestone May 8, 2024
@jackdos jackdos self-assigned this May 8, 2024
@jackdos
Copy link
Collaborator Author

jackdos commented May 8, 2024

I made a minor amendment to what the ticket (#21) said we should do, in that we specified that the parameters would be passed as an array of objects, but when implementing it seemed less verbose to make the parameters object essentially a string -> string map, so it's declared as a object with arbitrary keys and string values.

I've also used "patternProperties", which seems fine in JSON schema, but I've been struggling to get the OpenAPI spec to validate (quite a few tools seem to not like 3.1.0) or to generate the HTML, so I'm not 100% sure that that is as well supported in the API spec.

Copy link
Member

@carlwilson carlwilson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is fine TBH, see my niggly comments about wording though. These could be applied in a few places.

api/par-api.yaml Outdated Show resolved Hide resolved
api/par-api.yaml Outdated Show resolved Hide resolved
@carlwilson carlwilson self-requested a review June 12, 2024 12:05
@carlwilson carlwilson merged commit d07c6f8 into openpreserve:main Jun 12, 2024
5 checks passed
@carlwilson carlwilson linked an issue Jun 12, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API listing responses don't include counts or paging information
2 participants