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 service-doc to core links table, add links diagram #133

Merged
merged 3 commits into from
May 17, 2021

Conversation

philvarner
Copy link
Collaborator

Related Issue(s): #116

Proposed Changes:

  1. add service-doc to Links page
  2. add Links diagram

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG or a CHANGELOG entry is not required.

Copy link
Collaborator

@cholmes cholmes left a comment

Choose a reason for hiding this comment

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

Looks good. I think my only question with this is if we want to make service-desc and service doc to be 'optional' elements in the core spec?

The reasoning would be that today if you wanted to include those right now you're supposed to fully implement the features API. Of course nothing would stop you from including them, so maybe it doesn't really matter. I think it'd just be a bit more endorsement to recommend people use it even if they're just implementing core + item-search.

@philvarner
Copy link
Collaborator Author

Looks good. I think my only question with this is if we want to make service-desc and service doc to be 'optional' elements in the core spec?

The reasoning would be that today if you wanted to include those right now you're supposed to fully implement the features API. Of course nothing would stop you from including them, so maybe it doesn't really matter. I think it'd just be a bit more endorsement to recommend people use it even if they're just implementing core + item-search.

I think we want to at least recommend, if not require it -- it's just good practice, and we already have an openapi schema they can use for it.

I don't understand "if you wanted to include those right now you're supposed to fully implement the features API. " -- where is that required?

@m-mohr
Copy link
Collaborator

m-mohr commented May 14, 2021

Those two rel types originate in OGC APIs and you have to implement them for being OGC API compliant.

For STAC core, which may just be a browsable catalog and not even have a OpenAPI, I'd highly recommend to not require it. I could see us recommending it, but feel more just giving the option and the implementor has to choose. I don't see them used often in clients so it may only be a "human" thing to look at these. From a RESTful point of view (and we claim being RESTful), OpenAPIs should actually not even be a thing as everything can be just retrieved from the links.

@philvarner
Copy link
Collaborator Author

Those two rel types originate in OGC APIs and you have to implement them for being OGC API compliant.

This made me realize that we don't want this example Landing Page in core -- we should have one that is what you would see if you only implement core, e.g., no rel=search. We should also have these for the other 2, and then a 4th example of what a complete API that implements all 3 would look like.

@philvarner philvarner merged commit 76b66bf into radiantearth:dev May 17, 2021
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.

3 participants