RFC 5785 conventions & suggested OpenAPI document locations
See original GitHub issueRFC 5785 “Defining Well-Known URIs” provides for a standardized path where documents for…
“the discovery of policy or other information about a host (‘site-wide metadata’) before making a request”`
…can be placed, for easy discovery.
Should the OpenAPI Specification be modified to suggest using a /.well-known/
URI for APIs that occupy the root level of a hostname?
Issue Analytics
- State:
- Created 5 years ago
- Reactions:8
- Comments:5 (2 by maintainers)
Top Results From Across the Web
Standard Location and Name of OpenAPI Document
There evidentially isn't a standard location to put it in but is there a de ... RFC 5785 conventions & suggested OpenAPI document...
Read more >OpenAPI Specification - Version 3.0.3 - Swagger
It is RECOMMENDED that the root OpenAPI document be named: openapi.json or ... the host location is relative to the location where the...
Read more >OCF Cloud Open API
Document conventions and organization . ... IETF RFC 5785, Defining Well-Known Uniform Resource Identifiers (URIs), April 2010 ... Location. Description.
Read more >Issues · OAI/OpenAPI-Specification · GitHub
Contribute to OAI/OpenAPI-Specification development by creating an account on GitHub. ... RFC 5785 conventions & suggested OpenAPI document locations.
Read more >APIs.yaml
xml. Providing an index of internal, partner, and public APIs, which includes not just the the OpenAPI, JSON Schema, and other machine readable ......
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
I just came across this issue and while looking into it also stumbled on a draft informational RFC that proposes a web link with the
service-desc
relation. In theory the actual location wouldn’t matter (the document could be hosted on a separate host for instance): so long as the service returned a header along the lines ofLink: </openapi.yaml>;rel="service-desc";type="application/vnd.oai.openapi"
.This I-D proposes to register
service-desc
to Well-Known URI IANA Registry https://ioggstream.github.io/draft-polli-service-description-well-known-uri/draft-polli-service-description-well-known-uri.htmlFeedback welcome. @shockey In case it fits we could delegate the issue to this I-D.