Skip to content

Hyperlink support in Swagger #198

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

Closed
Shulamite opened this issue Nov 10, 2014 · 13 comments
Closed

Hyperlink support in Swagger #198

Shulamite opened this issue Nov 10, 2014 · 13 comments

Comments

@Shulamite
Copy link

It will be nice to provide support for link relations in swagger.

@drewzboto
Copy link

+1. Happy to contribute to shaping this one

@fehguy
Copy link
Contributor

fehguy commented Nov 28, 2014

I would suggest starting with how you would want both the ui and clients to take advantage of link support

@drewzboto
Copy link

Sounds like a plan. @mattbishop let's chat

@ashokmalhotra
Copy link

There has been no action on this since Nov 28. If we want to use Swagger as a description language, this is a deal-breaker.

@webron
Copy link
Member

webron commented May 29, 2015

@ashokmalhotra - unlike the tooling, the spec doesn't change too often. We've released 2.0 back in September so you shouldn't expect seeing a new version this soon.

@ashokmalhotra
Copy link

Is there enough interest to add Link support to the spec?
Can you give me a rough date?

@webron
Copy link
Member

webron commented May 29, 2015

Really too early to say. There's definitely interest in it and we'll discuss it when the time comes.

And no, I cannot give you a rough date.

@webron
Copy link
Member

webron commented Mar 27, 2016

Parent: #555.

@Shulamite
Copy link
Author

We are currently using x-links in swagger, and the content of x-links is pretty much the json hyper schema's links.
http://json-schema.org/latest/json-schema-hypermedia.html

@awwright
Copy link

How are hyperlinks currently implemented?

@darrelmiller
Copy link
Member

@awwright In v3 operations can be related via the links object (some description here https://www.openapis.org/blog/2016/11/14/tdc-protocol-and-payload-explaining-the-3-0-spec-part-4 ). However this is purely a design time concept.
Any operation request or response can be described using a hypermedia enabled media type. But OpenAPI makes no attempt to describe what links may or may not appear in those hypermedia payloads.

@philsturgeon
Copy link
Contributor

So what do we think about this one? Is links enough, are we leaving the rest to the hypermedia formats of the world, or is there ever likely to be further work on hypermedia.

@darrelmiller
Copy link
Member

The only other work I see is the ability to define path Item Objects that don't have a fixed URL. And we sort of are doing that with making Path Item Objects components. I don't think there is anything novel in this issue to warrant keeping it open.

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

8 participants