search

yakshaveinc / tasks

distributed roadmap
The Unlicense
1 stars 0 forks source link

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

Open abitrolly opened 5 years ago

abitrolly commented 5 years ago

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 commented 5 years ago

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

abitrolly commented 5 years ago

Request sent:

URI suffix: openapi

Change controller: anatoli@rainforce.org, https://github.com/yakshaveinc/tasks/issues/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