Support discovering OpenAPI document from `Link` header?
See original GitHub issueI’m looking at various options to “upgrade” a simple API (HTTP POST of CloudEvents) to allow clients and servers to be able to extend into more complex OpenAPI space (e.g. “what events are you interested in” or “what types of events might be returned in the HTTP response”).
One attractive option would be to provide a Link
header pointing to the OpenAPI spec on the existing endpoint to provide a hint that upgrade is available.
I don’t see a documented rel
(relation) value for OpenAPI; would something like “oas-3.0” be a reasonable value?
Issue Analytics
- State:
- Created 4 years ago
- Comments:9 (4 by maintainers)
Top Results From Across the Web
OpenAPI Specification - Version 3.0.3 - Swagger
The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and ...
Read more >OpenAPI extensions | Cloud Endpoints with OpenAPI
This page describes Google- specific extensions to the OpenAPI specification. ... service configuration as well, this header applies only to URL paths that ......
Read more >ReadMe: OpenAPI and Swagger for API Documentation
The easiest way to see how your OpenAPI or Swagger file looks as documentation is to generate it with ReadMe. You can add...
Read more >OpenAPI Definition & Online Tools | Open API Standards List
There are three primary areas in every OpenAPI document: Endpoints (i.e. paths appended to the server URL) and the HTTP methods they support....
Read more >OpenAPI Specification v3.1.0 | Introduction, Definitions, & More
3.1 OpenAPI Document; 3.2 Path Templating; 3.3 Media Types ... to discover and understand the capabilities of the service without access to ...
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 FreeTop 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
Top GitHub Comments
I think more generically
service-desc
might suit the bill. See https://tools.ietf.org/html/rfc8631See #1511 #724 #734 for previous discussions including
describedBy
, and #110 for a proposed media-type for OAS documents.I recall @darrelmiller had some objection to using a
.well-known
URI for this case - could we document it here? It may have been that an OpenAPI document doesn’t meet the criteria ofOf course one issue it doesn’t cater for is an organisation having many APIs (which could be handled by something like apis.json). There is also the schema.org WebAPI type in this discovery space.