Several small amendments to initial overlay spec version #3
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
Signed-off-by: Mike Ralphson <[email protected]>
webron
reviewed
Jul 5, 2021
Co-authored-by: Ron <[email protected]>
This will help the respec rendering
webron
reviewed
Jul 6, 2021
There was a problem hiding this comment.
Changes look good, and there's no need to wait for the weekly call to merge them (it's not the core spec nor a published one).
Added a couple of comments.
The only thing I'm unsure about is the extensions - that's something we have not discussed whether we want to include in the Overlay spec, which is why I kept the content of the extension, but triple starred it (***) - it wasn't meant to be bold.
|
|
||
| Field Pattern | Type | Description | ||
| ---|:---:|--- | ||
| <a name="infoExtensions"></a>^x- | Any | Allows extensions to the OpenAPI Schema. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value can be `null`, a primitive, an array or an object. | ||
| <a name="overlayExtensions"></a>^x- | Any | Allows extensions to the Overlay Specification. The field name MUST begin with `x-`, for example, `x-internal-id`. Field names beginning `x-oai-` and `x-oas-` are reserved for uses defined by the [OpenAPI Initiative](https://www.openapis.org/). The value MAY be `null`, a primitive, an array or an object. |
There was a problem hiding this comment.
This actually means there's a good chance there's an error in the OAS anchor for ^x-.
There was a problem hiding this comment.
Oh, I see what you mean - will check.
Assuming that one TSC is going to serve for both specs for the moment This will also help production of the ReSpec version of the spec
darrelmiller
approved these changes
Jul 31, 2021
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.
Signed-off-by: Mike Ralphson [email protected]
I've also put up a respec-rendered version of the spec here just so we can see what needs changing in the generation script (e.g. references to OAS etc).