-
Notifications
You must be signed in to change notification settings - Fork 27
Fixes examples for compliance with RFC-9535 #118
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
Conversation
7267307 to
96cf4c2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
|
@mikekistler @gregsdennis Will this query work if we keep the original openapi: 3.1.0
info:
title: API with a paged collection
version: 1.0.0
paths:
/items:
get:
x-oai-traits: ['paged']
responses:
200:
description: OKEDIT: It appears to work with Speakeasy's tooling. |
|
Yeah, that's compliant @kevinswiber. |
|
Thanks @kevinswiber and @gregsdennis for puzzling out how to use the original x-oai-traits with array value. I've updated the PR to incorporate this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy to approve this but we still have some requested changes to look at.
|
@mikekistler Please re-target to |
24391ca to
2aa95c3
Compare
|
I have rebased on main and moved the changes to versions/1.1.0-dev.md. @ralfhandl @baywet this is ready for re-review. |
| version: 1.0.0 | ||
| actions: | ||
| - target: $.paths[[email protected]['x-oai-traits'][?@ == 'paged']].get | ||
| - target: $.paths.*.get[?(@['x-oai-traits'][?(@ == 'paged')])] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change isn't necessary for RFC-9535, but it would increase the compatibility with legacy libraries.
This PR makes a few minor fixes to the overlay examples to ensure they are compliant with RFC-9535.
I tested all the examples in the spec with Speakeasy's overlay playground and only these two had problems.
Note that any examples that use filters need
but I did not include that in the examples.