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

add links to ssh key endpoints #16

Merged
merged 1 commit into from
Jul 23, 2020
Merged

add links to ssh key endpoints #16

merged 1 commit into from
Jul 23, 2020

Conversation

hilary
Copy link
Contributor

@hilary hilary commented Jul 22, 2020

No description provided.

@hilary hilary requested a review from scotchneat July 22, 2020 20:30
Copy link
Contributor

@scotchneat scotchneat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-blocking thoughts/feedback:

When rendering the docs using SwaggerUI, it adds some useful documentation alongside respective resources for users. However, it's not fully rendered with the response body until a request is tested and even still, the UI has some requirements on the backing API to support CORS for that to work.

However, the links aren't rendering in the Redocly preview (openapi-cli). If we converge on this format, which it sounds like we are, we wont be able to take advantage of the link documentation until that tooling can support it.

Otherwise, this lgtm.

@hilary
Copy link
Contributor Author

hilary commented Jul 23, 2020

Carrying on with @scotchneat's comments, links supports a server object for each link. That server object is a true server object in that it can be templated with variables in { } brackets and do variable substitution.

@hilary hilary merged commit 5167c92 into main Jul 23, 2020
@hilary hilary deleted the APICLI-381 branch July 23, 2020 22:04
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

Successfully merging this pull request may close these issues.

2 participants