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

Is the openAPI spec (eventually) normative or informative? #118

Open
iherman opened this issue Jan 31, 2025 · 2 comments
Open

Is the openAPI spec (eventually) normative or informative? #118

iherman opened this issue Jan 31, 2025 · 2 comments

Comments

@iherman
Copy link
Member

iherman commented Jan 31, 2025

At this moment, there is a reference in the section on HTTP(S) binding to https://github.com/decentralized-identity/universal-resolver/blob/main/openapi/openapi.yaml.

  1. If this is informative, we should say so (e.g., by putting it into a note)
  2. if this is normative, then the yml file should be brought over to the W3C spec either by normative reference locally or by inclusion.

Personally, my preference would be (2), but I am not sure if that is possible. E.g., I do not know whether openAPI is technically stable for W3C usage.

@peacekeeper
Copy link
Collaborator

I don't have much experience with this, is it common for W3C specs to include normative API definitions? I think OpenAPI does have stable versions.

But what happens if there is some kind of conflict between the spec text and the OpenAPI definition?

@iherman
Copy link
Member Author

iherman commented Feb 7, 2025

I don't have much experience with this, is it common for W3C specs to include normative API definitions? I think OpenAPI does have stable versions.

It is up to the WG, so I do not see why not. In a way, all W3C recommendations that publish an API using WebIDL do that, just using a different formalism (there are many reasons why we should not use WebIDL).

But what happens if there is some kind of conflict between the spec text and the OpenAPI definition?

Then we have a problem :-) That is why the requirement for (normative) references is that the definition must be, technically, stable.

If that is the case with OpenAPI, then my issue is moot and can be closed. But I am not familiar enough with that world to decide that...

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

No branches or pull requests

2 participants