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

Register .well-known/openapi endpoint with IANA for OpenAPI autodiscovery #48

Open
abitrolly opened this issue Jul 10, 2019 · 2 comments

Comments

@abitrolly
Copy link
Member

abitrolly commented Jul 10, 2019

Make http://example.com/.well-known/openapi an URL to full API specification for a given resource. For example, the URL above could point to https://api.example.com/v2/openapi.json

https://en.wikipedia.org/wiki/List_of_/.well-known/_services_offered_by_webservers

If .well-known URL can not be found, the browser could also request http://example.com/openapi.json as a last resort.

The task is to send proposal to IANA.

@abitrolly abitrolly changed the title Register .well-known/openapi endpoint for OpenAPI autodiscovery Register .well-known/openapi endpoint with IANA for OpenAPI autodiscovery Jul 10, 2019
@abitrolly
Copy link
Member Author

https://tools.ietf.org/html/rfc5785 describes the procedure.

@abitrolly
Copy link
Member Author

Request sent:

URI suffix: openapi

Change controller: anatoli@rainforce.org,
#48

Specification document(s): The field returns URL to OpenAPI
specification. For example, http://example.com/.well-known/openapi
could return https://api.example.com/v2/openapi.json

Related information: https://en.wikipedia.org/wiki/OpenAPI_Specification

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

1 participant