Skip to content

Conversation

@ioggstream
Copy link
Collaborator

@ioggstream ioggstream commented Sep 15, 2025

This PR

@ioggstream ioggstream requested a review from handrews September 15, 2025 11:17
@ioggstream ioggstream self-assigned this Sep 15, 2025
@ioggstream ioggstream added this to the WGLC for REST API milestone Sep 15, 2025
@handrews
Copy link
Collaborator

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).

@handrews
Copy link
Collaborator

See #121 (comment) for some questions I'm trying to figure out which apply in part to this PR as well.

@ioggstream
Copy link
Collaborator Author

@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?

@handrews
Copy link
Collaborator

handrews commented Dec 9, 2025

@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.

@handrews
Copy link
Collaborator

handrews commented Dec 9, 2025

Terminology can be deferred to an editorial review: WDYT?

I think the terminology is the central concern here.

@ioggstream
Copy link
Collaborator Author

ioggstream commented Dec 10, 2025

different between "document" and "resource"

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.

The target of an HTTP request is called a "resource".

We use the term "resource" here because we do not know beforehand what will be the media type of its "representation":
it could be JSON, YAML, ... Client can only express its preference.

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.
Since OAS terminology changes between versions (Document, Description, description, ...)
and may change in the future, this is something that should be probably be deferred to OAS.

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.

@ioggstream ioggstream merged commit 0582ce8 into main Dec 11, 2025
2 checks passed
@ioggstream ioggstream deleted the ioggstream-125 branch December 11, 2025 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support (and reference) all OAS version from 2.0

3 participants