-
Notifications
You must be signed in to change notification settings - Fork 4
Fix: #125. Support OAS 2.0. #126
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
ababf7d to
1dbd3ea
Compare
|
Started looking at this- I need to think on the "OpenAPI Document" terminology as it really wasn't formalized until 3.0.4/3.1.1, but we actually streamlined the terminology somewhat in 3.2. I'll figure out what makes sense across the versions, which might tweak the text here and/or call for another PR (which I will submit if I think one is needed). |
|
See #121 (comment) for some questions I'm trying to figure out which apply in part to this PR as well. |
b552026 to
194cae2
Compare
|
@handrews PTAL. Use generic terms. The goal for this PR is to support OAS2.0: if we agree, I'd say that for this scope, good enough is good enough. Terminology can be deferred to an editorial review: WDYT? |
|
@ioggstream I feel like there is a gap in understanding here, as the question of whether this applies to OpenAPI Documents or some broader "OpenAPI resource" concept is central to what we are discussing in PR #121, which at this point is re-opening the discussion from #110. I would like to figure this out before accepted any PR, as it seems to all be the same thing. In particular,it is really not clear to me what you think is different between "document" and "resource" other than perhaps the root Object type, which is the concern under discussion in #121. So I'm not willing to endorse "resource" without a clear understanding of the implications. |
I think the terminology is the central concern here. |
See https://ietf-wg-httpapi.github.io/mediatypes/draft-ietf-httpapi-rest-api-mediatypes.html#section-1.1-2: the term "resource" is from HTTP.
We use the term "resource" here because we do not know beforehand what will be the media type of its "representation": A resource can be represented using formats associated with different media types (e.g., application/json, application/yaml). A "document" is whatever the associated OAS specification decides to be a document. OT: wrt the OpenAPI Object, I strongly suggest it should be the focus of other PRs, to avoid it to be a show-stopper for the publication. |
This PR