-
Notifications
You must be signed in to change notification settings - Fork 47
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
Reorg conformance uris, endpoints, links, and maturity classification #240
Merged
philvarner
merged 9 commits into
radiantearth:dev
from
philvarner:reorg-conformance-uris-endpoint-and-links
Jan 5, 2022
Merged
Changes from 3 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
0f1ff40
Merge pull request #216 from radiantearth/dev
philvarner ab633b2
update maturity, reorganize top list, add note on endpoint and links
philvarner dfacb8e
reorder top entries
philvarner febbe86
move maturity classification
philvarner 6824af7
reword query extension language
philvarner 0e5500d
lint fix
philvarner dc27246
revert maturity classification updates
philvarner 2f84e28
Merge branch 'master' into reorg-conformance-uris-endpoint-and-links
philvarner 72f852c
reword principles reference to maturity classification
philvarner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,6 +6,7 @@ | |
- [STAC API](#stac-api) | ||
- [About](#about) | ||
- [Stability Note](#stability-note) | ||
- [Maturity Classification](#maturity-classification) | ||
- [Communication](#communication) | ||
- [In this repository](#in-this-repository) | ||
- [Contributing](#contributing) | ||
|
@@ -16,7 +17,6 @@ The SpatioTemporal Asset Catalog (STAC) family of specifications aim to standard | |
A 'spatiotemporal asset' is any file that represents information about the earth captured in a certain space and | ||
time. The core STAC specifications live in the GitHub repository [radiantearth/stac-spec](https://github.com/radiantearth/stac-spec). | ||
|
||
|
||
A STAC API is the dynamic version of a SpatioTemporal Asset Catalog. It returns a STAC [Catalog](stac-spec/catalog-spec/catalog-spec.md), | ||
[Collection](stac-spec/collection-spec/collection-spec.md), [Item](stac-spec/item-spec/item-spec.md), | ||
or a STAC API [ItemCollection](fragments/itemcollection/README.md), depending on the endpoint. | ||
|
@@ -36,11 +36,34 @@ rendered online into HTML at <https://api.stacspec.org/v1.0.0-beta.5>, in additi | |
## Stability Note | ||
|
||
This specification has evolved over the past couple years, and is used in production in a variety of deployments. It is | ||
currently in a 'beta' state, with no major changes anticipated. For 1.0-beta we remain fully aligned with [OGC API - | ||
currently in a 'beta' state, with no major changes anticipated. For 1.0.0-beta.5, we remain fully aligned with [OGC API - | ||
Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) Version 1.0, and we are working to stay aligned | ||
as the additional OGC API components mature. This may result in minor changes as things evolve. The STAC API | ||
specification follows [Semantic Versioning](https://semver.org/), so once 1.0.0 is reached any breaking change | ||
will require the spec to go to 2.0.0. | ||
will require the spec to go to 2.0.0. | ||
|
||
## Maturity Classification | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this was moved from Extensions, since it applies to both the regular conformance classes and extensions |
||
|
||
Conformance classes and extensions are meant to evolve to maturity, and thus may be in different states | ||
in terms of stability and number of implementations. All extensions must include a | ||
maturity classification, so that STAC API spec users can easily get a sense of how much they can count | ||
on the extension. | ||
|
||
| Maturity Classification | Min Impl # | Description | Stability | | ||
| ----------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | | ||
| Proposal | 0 | An idea put forward by a community member to gather feedback | Not stable - breaking changes almost guaranteed as implementers try out the idea. | | ||
| Pilot | 1 | Idea is fleshed out, with examples and a JSON schema, and implemented in one or more catalogs. Additional implementations encouraged to help give feedback | Approaching stability - breaking changes are not anticipated but can easily come from additional feedback | | ||
| Candidate | 3 | A number of implementers are using it and are standing behind it as a solid extension. Can generally count on an extension at this maturity level | Mostly stable, breaking changes require a new version and minor changes are unlikely. | | ||
| Stable | 6 | Highest current level of maturity. The community of extension maintainers commits to a STAC review process for any changes, which are not made lightly. | Completely stable, all changes require a new version number and review process. | | ||
| Deprecated | N/A | A previous extension that has likely been superseded by a newer one or did not work out for some reason. | Will not be updated and may be removed in an upcoming major release. | | ||
|
||
Maturity mostly comes through diverse implementations, so the minimum number of implementations | ||
column is the main gating function for an extension to mature. But extension authors can also | ||
choose to hold back the maturity advancement if they don't feel they are yet ready to commit to | ||
the less breaking changes of the next level. | ||
|
||
A 'mature' classification level will likely be added once there are extensions that have been | ||
stable for over a year and are used in twenty or more implementations. | ||
|
||
## Communication | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what "fully accepted" means here, since 3 impls is what we call Candidate in the Maturity Classification model. Rewording to just not be inconsistent with the MC.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think this predates extensions, and I think fully accepted was meant to mean like 1.0.0? Change looks good.