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 alternative versions to capabilities #148

Closed
m-mohr opened this issue Nov 5, 2018 · 1 comment
Closed

Add alternative versions to capabilities #148

m-mohr opened this issue Nov 5, 2018 · 1 comment
Milestone

Comments

@m-mohr
Copy link
Member

m-mohr commented Nov 5, 2018

If a server supports multiple API versions (e.g. 0.0.2 and 0.3.0) this could be advertised by the capabilities in GET /. This would allow clients to switch to the "best" supported version. Example:

{
  "version": "0.4.0",
  "versions": {
    "0.0.2": "http://test.org/v0",
    "0.3.1": "http://test.org/v0.3",
    "1.0.0": "http://test.org/v1.0"
  },
  "endpoints": [
    {
      "path": "/collections",
      "methods": [
        "GET"
      ]
    },
    {
      "path": "/collections/{name}",
      "methods": [
        "GET"
      ]
    },
    {
      "path": "/processes",
      "methods": [
        "GET"
      ]
    }
  ]
}

Better would be to have it one level higher as it wouldn't require changing running versions, but that's hard to specify. But maybe we can implement a "well known" URI, similar to what OpenID Connect has.

http://www.example.com/.well-known/openeo could serve:

{
  "versions": {
    "0.0.2": "http://test.org/v0",
    "0.3.1": "http://test.org/v0.3",
    "1.0.0": "http://test.org/v1.0"
  }
}
@m-mohr m-mohr added this to the v0.4 milestone Nov 5, 2018
m-mohr added a commit that referenced this issue Dec 6, 2018
…ditional required property `paid`. (#157) . Added Well-Known URI allows clients to choose between versions. (#148)
@m-mohr
Copy link
Member Author

m-mohr commented Dec 6, 2018

Implemented.

@m-mohr m-mohr closed this as completed Dec 6, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant