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

Fix: #110. Schema Object parameter #118

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Fix: #110. Schema Object parameter #118

wants to merge 4 commits into from

Conversation

ioggstream
Copy link
Collaborator

This PR

  • convey schema-objects

@handrews
Copy link
Collaborator

handrews commented Nov 4, 2024

@ioggstream I'm assuming this is a work-in-progress as objects aren't mentioned yet? Also, this will need to apply to any reference-able Object, not just the Schema Object (although handling the Schema Object will give us an OAS-specific way to manage schema media types, so it's extra-valuable there).

@ioggstream
Copy link
Collaborator Author

@darrelmiller during https://datatracker.ietf.org/doc/minutes-121-httpapi-202411061300/ I understood that 3.0.4 allowed referencing external schemas that do not have the classical structure {paths: {}, components: {}, ..}

Can you please point me to the relevant part of the OAS 3.0.4 spec pls?

@handrews
Copy link
Collaborator

@darrelmiller during https://datatracker.ietf.org/doc/minutes-121-httpapi-202411061300/ I understood that 3.0.4 allowed referencing external schemas that do not have the classical structure {paths: {}, components: {}, ..}

Can you please point me to the relevant part of the OAS 3.0.4 spec pls?

@ioggstream Historically, there was nothing explicit in the spec, it's just not forbidden and is commonly used, particularly by tools that split OpenAPI Descriptions into multiple documents for editing, and then combine them back to a single document because many tools don't support multiple documents well (if at all).

It is still not explicitly addressed in 3.0.4, although there is more discussion of the topic of multiple documents in general.

3.1.1 has additional directions regarding parsing as the processing model changed between 3.0 and 3.1. This talks more explicitly about documents without an OpenAPI Object at the root.

Note that everything in 3.0.4 applies to all 3.0.x versions, and 3.1.1 also applies to 3.1.0 – patch releases are essentially updates-with-errata, not distinct versions with their own behaviors.

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.

2 participants