Additional fields for the tag object #4288
Open
+42
−7
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
baywet
approved these changes
Jan 9, 2025
lornajane
commented
Jan 9, 2025
miqui
previously approved these changes
Jan 9, 2025
|
Love this. As an implementor, the first thing that comes to mind is "now I need to write an interface "get me a list of all the operations with a particular tag kind". |
LasneF
reviewed
Jan 9, 2025
|
mikekistler
previously approved these changes
Jan 10, 2025
| | <a name="tag-description"></a>description | `string` | A description for the tag. [CommonMark syntax](https://spec.commonmark.org/) MAY be used for rich text representation. | | ||
| | <a name="tag-external-docs"></a>externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. | | ||
| | <a name="tag-parent"></a>parent | `string` | The `name` of a tag that this tags is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. | | ||
| | <a name="tag-kind"></a>kind | `string` | A machine-readable string to categorize what sort of tag it is. Any string value can be used; common uses are `nav` for Navigation, `badge` for visible badges, `audience` for APIs used by different groups. A [registry of the most commonly used values](https://spec.openapis.org/registry/tag-kind/) is available. | |
There was a problem hiding this comment.
Does "machine-readable" add anything here? Isn't the entire description machine readable? It's a minor point but it might raise doubts for some readers.
There was a problem hiding this comment.
I like it because it makes clear that this field is not intended for prose text.
Co-authored-by: Mike Kistler <[email protected]>
ralfhandl
approved these changes
Jan 10, 2025
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.
Implementation of the proposal to extend the functionality offered by tags. The main features:
summaryfield in addition to their descriptionkindto say what sort of tag they are, so we can use tags for many; Add tag kinds registry to the spec site #4287 adds a registry for the most common typesPull request still in draft because I would like to link to the registry but it doesn't exist yet so we should not merge - review feedback very welcome though!