Skip to content

Conversation

@mikekistler
Copy link
Contributor

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

x-speakeasy-jsonpath: rfc9535

but I did not include that in the examples.

@mikekistler mikekistler changed the base branch from main to v1.0-dev February 11, 2025 16:30
lornajane
lornajane previously approved these changes Feb 11, 2025
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Thanks!

@kevinswiber
Copy link

kevinswiber commented Feb 11, 2025

@mikekistler @gregsdennis Will this query work if we keep the original x-oai-traits example?

$.paths[[email protected]['x-oai-traits'][?@ == 'paged']].get
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: OK

EDIT: It appears to work with Speakeasy's tooling.

@gregsdennis
Copy link
Contributor

Yeah, that's compliant @kevinswiber.

@mikekistler
Copy link
Contributor Author

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.

lornajane
lornajane previously approved these changes Mar 11, 2025
Copy link
Contributor

@lornajane lornajane left a 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.

@lornajane lornajane requested review from a team and ralfhandl March 11, 2025 15:53
@ralfhandl ralfhandl mentioned this pull request Oct 22, 2025
5 tasks
@ralfhandl
Copy link
Contributor

@mikekistler Please re-target to main, changing file versions/1.1.0-dev.md - might require copying the changed file to a new branch off main.

@mikekistler mikekistler changed the base branch from v1.0-dev to main October 28, 2025 18:41
@mikekistler mikekistler requested a review from a team as a code owner October 28, 2025 18:41
@mikekistler
Copy link
Contributor Author

I have rebased on main and moved the changes to versions/1.1.0-dev.md.

@ralfhandl @baywet this is ready for re-review.

@ralfhandl ralfhandl requested review from baywet and lornajane November 4, 2025 18:24
@baywet baywet merged commit 017cce5 into main Nov 4, 2025
4 checks passed
@baywet baywet deleted the mdk/rfc-9535 branch November 4, 2025 18:32
version: 1.0.0
actions:
- target: $.paths[[email protected]['x-oai-traits'][?@ == 'paged']].get
- target: $.paths.*.get[?(@['x-oai-traits'][?(@ == 'paged')])]
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants