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

Explain that dynamic refs can implement generics #3714

Merged
merged 8 commits into from May 9, 2024

Conversation

handrews
Copy link
Contributor

Fixes #3601.

Includes an example. This intentionally does not explain how dynamic referencing works, as there are better resources available in both the spec and (more readably) the official JSON Schema blog.

Includes an example.  This intentionally does not explain how
dynamic referencing works, as there are better resources available
in both the spec and (more readably) the official JSON Schema blog.
@handrews handrews requested a review from a team April 18, 2024 19:21
@vicspina

This comment was marked as off-topic.

versions/3.1.1.md Outdated Show resolved Hide resolved
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
versions/3.1.1.md Outdated Show resolved Hide resolved
versions/3.1.1.md Outdated Show resolved Hide resolved
@handrews handrews added this to the v3.1.1 milestone Apr 20, 2024
@handrews
Copy link
Contributor Author

To add a little more context (with apologies for the rapid-fire comment spam):

  • This feature is (as noted above) highly desired and has been requested repeatedly since 2015
  • It is implemented in some places (I believe that @gregsdennis , who wrote the JSON Schema Blog's post about it, supports it in C#)
  • $dynamicRef and $dynamicAnchor are kind of the discriminator of 3.1 – there was a long period where I noticed many OpenAPI tools claimed they supported everything, but with an asterisk saying "except discriminator... part of the reason for this is that these new keywords are moderately complex. But part of it is that people don't understand that they can support a common programming paradigm that is otherwise unsupportable. We will not see these implemented unless they are connected to real customer use cases, and that's what this PR does.

versions/3.1.1.md Outdated Show resolved Hide resolved
versions/3.1.1.md Outdated Show resolved Hide resolved
versions/3.1.1.md Outdated Show resolved Hide resolved
versions/3.1.1.md Outdated Show resolved Hide resolved
handrews and others added 4 commits April 25, 2024 06:08
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Co-authored-by: Ralf Handl <ralf.handl@sap.com>
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

@lornajane lornajane merged commit a602c46 into OAI:v3.1.1-dev May 9, 2024
1 check passed
@handrews handrews deleted the generics branch May 9, 2024 19:30
handrews added a commit that referenced this pull request May 16, 2024
Explain dynamic refs for generics (3.2.0 port of #3714)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants