Edit pass of readme and spec #75
Merged
Conversation
This file contains hidden or 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
for your consideration
this was the only place in the document that was not linked to the OpenAPI Specification for these words.
README.md
Outdated
|
|
||
| ## Current Status | ||
|
|
||
| The current specification is sufficiently stable for implementers to start experimenting. We are looking for implementation experience to guide our decisions on the remaining open issues. | ||
| The current specification is sufficiently stable for implementers to start experimenting. We are looking for implementation experience to guide our decisions on the remaining open issues. |
There was a problem hiding this comment.
This text doesn't seem relevant any more for a 1.0.0 release.
There was a problem hiding this comment.
I support striking it altogether.
ralfhandl
reviewed
Oct 14, 2024
ralfhandl
reviewed
Oct 14, 2024
ralfhandl
reviewed
Oct 14, 2024
ralfhandl
approved these changes
Oct 14, 2024
jeremyfiel
reviewed
Oct 14, 2024
| - Allowing separation of concerns for metadata such as gateway configuration or SLA information | ||
| - Supporting a traits-like capability for applying a set of configuration data, such as multiple parameters or multiple headers, for targeted objects | ||
| - Providing default responses or parameters where they were not explicitly provided | ||
| - Appling configuration data globally or based on filter conditions |
There was a problem hiding this comment.
Suggested change
| - Appling configuration data globally or based on filter conditions | |
| - Applying configuration data globally or based on filter conditions |
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.
Feel free to reject any/all suggestions! My goal was simply to tighten up language wherever I thought I spotted an opportunity.
Note that the readme frames the intro and use cases slightly differently, which is either an opportunity to reconcile those somehow or an added dimension.
One small question... would it make sense to offer a recommended naming pattern for Overlay documents? I expect most will end with
.yaml, but we might offer a way to identify Overlays from the file name without needing to introspect. For example:french-translation.overlay.yaml