Define "beta" features and replace the optional/required designation for endpoints #468
Conversation
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
jfh01
added
Provider
|
LGTM |
|
perfect! |
|
Great! |
thekaveman
approved these changes
Mar 16, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Explain pull request
This pull request defines the idea of a "beta" feature and replaces the optional/required designation (#456) on the
providerAPI endpoints with a beta yes/no designation.This is a proposed change to the 0.4.1 release candidate that emerged from review by the OMF Technology Council. The concern identified by the Council is that "optional/required" does not clearly communicate if, when, and how an endpoint should be used. For example, is it OK for a regulator to ask a provider to implement an optional endpoint? For what purposes is it appropriate to use an optional endpoint?
The new "beta" language attempts to remove this ambiguity by honestly communicating what users can expect in terms of the completeness, quality, and stability of newly added features. Users can then make an informed decision about when and how to use beta features.
Is this a breaking change
Impacted Spec
Which spec(s) will this pull request impact?
provider