Register x-oai-traits #25
Conversation
lornajane
left a comment
lornajane
left a comment
There was a problem hiding this comment.
Sorry, I started trying to edit the language and ended up thinking we might want to rename the whole thing!
I also don't have the new site set up locally for preview yet, but actually I wasn't ready to approve anyway so I've got time to sort that out!
| --- | ||
| owner: ralfhandl | ||
| issue: | ||
| description: Identify in an OpenAPI Description where Overlay updates should be applied. |
There was a problem hiding this comment.
I'm not sure this captures what we're trying to say here. I think we are mostly using the trait to give something for a target expression to aim for - it's not about what's applied
| --- | ||
|
|
||
| {% capture summary %} | ||
| The `x-oai-traits` extension is used identify places in an OpenAPI Description where Overlay updates should be applied. Its value is an array of strings, each string identifying a feature that an Overlay should apply. |
There was a problem hiding this comment.
| The `x-oai-traits` extension is used identify places in an OpenAPI Description where Overlay updates should be applied. Its value is an array of strings, each string identifying a feature that an Overlay should apply. | |
| The `x-oai-traits` extension is used to identify places in an OpenAPI Description where Overlay updates should be applied. Its value is an array of strings, each string identifying a feature that an Overlay should apply. |
There was a problem hiding this comment.
This explanation doesn't capture what I think we're trying to say. And when I tried to explain why, I ended up thinking that we may have mis-named the extension in the first place! It's not really a trait in the sense of the programming concept, because there is no room for per-instance implementation. What I think we're trying to describe (and we might want to write more and/or give examples beyond the content of the spec) is more like x-oai-target-label or something like that: a way for an overlay to identify a node to operate on.
Co-authored-by: Lorna Jane Mitchell <[email protected]>
|
I just copied the text from the spec section Traits Example. Maybe we should rephrase/rework that section first and then register whatever we end up with. |
The Overlay Specification uses a specification
x-oai-traitsto identify where overlay updates should be applied.Use JSON to represent an extension's schema instead of Jekyll's default Ruby notation.