rework example landing page, link rel table, and conformsTo #135
Conversation
…rmance classes to make it more clear which of them go with which conformance classes
| The base of a STAC API is its landing page. This resource is the starting point to discover what behaviors the API supports via link relations. | ||
| This behavior in a RESTful API is known as Hypermedia as the Engine of Application State (HATEOAS). STAC API relies heavily on hypermedia for API endpoint | ||
| navigation. | ||
| The base of a STAC API is its landing page. This resource is the starting point to discover what behaviors the API supports via the `conformsTo` values and link relations. |
There was a problem hiding this comment.
This isn't as large of a change as the diff implies -- I moved a couple sections around.
|
|
||
| ```json | ||
| { | ||
| "stac_version": "1.0.0-beta.2", | ||
| "id": "example-stac", | ||
| "title": "A simple STAC API Example", | ||
| "description": "This Catalog aims to demonstrate the a simple landing page", | ||
| "conformsTo" : [ |
There was a problem hiding this comment.
I moved conformsTo to the top of all the examples, since this is pretty critical to how most of the clients and validators are going to interact with the API
| @@ -30,11 +84,6 @@ navigation. | |||
| "type": "application/json", | |||
| "href": "https://stacserver.org" | |||
| }, | |||
| { | |||
There was a problem hiding this comment.
conformance, data, and search are not part of Core, so removed them from this example.
There was a problem hiding this comment.
Looks good. The one tweak I'd make is to add links to the other landing page examples from the core one. I get why you have reduced it, but now it's hard to get a sense from it alone what a 'real' landing page would look like. I was going to recommend a fuller example included at the bottom. But I see the other ones now have examples, so I think it can be sufficient to just link to them.
rework example landing page, link rel table, and conformsTo for conformance classes to make it more clear which of them go with which conformance classes
Related Issue(s): n/a
Proposed Changes:
PR Checklist: