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

Inconsistent handling of links in the releases resources #2

Open
odrotbohm opened this issue Jan 19, 2023 · 0 comments
Open

Inconsistent handling of links in the releases resources #2

odrotbohm opened this issue Jan 19, 2023 · 0 comments

Comments

@odrotbohm
Copy link

The releases resource uses links inside the actual release representation, using …Url suffixes for the properties that contain URIs. It would be more idiomatic to rather move those to the _links section:

{
  "",
  "_links" : {
    "api-doc" : {
      "href" : "",
      "type" : "text/html"
    },
    "reference-docs" : [
      { "href" : "", "type" : "text/html" },
      { "href" : "", "type" : "application/pdf" }
    ]
  }
}

Note, how that would allow us to advertise different formats for the reference documentation (it's currently only one link, which is fine for now) and also indicate that the api-doc link points to a browsable resource.

This would be a non-breaking change, as the links can be added without disturbing existing clients. The reference docs could incentivize using the HAL links though.

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

1 participant