Skip to content

Commit 741b7ee

Browse files
lornajaneralfhandl
andauthored
Apply suggestions from code review
Co-authored-by: Ralf Handl <[email protected]>
1 parent a3d1397 commit 741b7ee

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

proposals/2024-09-01-Tags-Improvement.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ On a personal note, I work for a tool vendor and was proposing these changes int
3333

3434
### Supporting evidence
3535

36-
There are several examples "in the wild" of where a better tags implementation would have helped. Here is a selection of publicly-accessible examples here to illustrate some of the problems this proposal could help with:
36+
There are several examples "in the wild" of where a better tags implementation would have helped. Here is a selection of publicly-accessible examples to illustrate some of the problems this proposal could help with:
3737

3838
- Grouping of tags is a very common use case, almost everyone uses some sort of extra hierarchy to group the tags themselves, which makes sense as our APIs are only getting more complex, something like [`x-tagGroups`](https://redocly.com/docs/api-reference-docs/specification-extensions/x-tag-groups/) is a good example - and there's a [very active open issue on OpenAPI specification itself](https://github.com/OAI/OpenAPI-Specification/issues/1367)
3939
- Various tag-alike additions exist, sometimes called "badges" or similar; I'd include extensions such as [`x-internal`](https://redocly.com/docs/cli/guides/hide-apis/#step-1-add-x-internal-to-the-api-description) as a tag-alike since they could be tags if more than one tag (or tag type) could be applied.
@@ -102,31 +102,42 @@ This object MAY be extended with [Specification Extensions](#specification-exten
102102

103103
```json
104104
{
105-
"name": "account-updates",
106-
"summary": "Account Updates",
107-
"description": "Account update operations",
108-
"type": "nav"
105+
"name": "account-updates",
106+
"summary": "Account Updates",
107+
"description": "Account update operations",
108+
"kind": "nav"
109109
},
110110
{
111-
"name": "partner",
112-
"summary": "Partner",
113-
"description": "Operations available to the partners network",
114-
"parent": "external",
115-
"type": "audience"
111+
"name": "partner",
112+
"summary": "Partner",
113+
"description": "Operations available to the partners network",
114+
"parent": "external",
115+
"kind": "audience"
116+
},
117+
{
118+
"name": "external",
119+
"summary": "External",
120+
"description": "Operations available to external consumers",
121+
"kind": "audience"
116122
}
117123
```
118124

119125
```yaml
120126
- name: account-updates
121127
summary: Account Updates
122128
description: Account update operations
123-
type: nav
129+
kind: nav
124130

125131
- name: partner
126132
summary: Partner
127133
description: Operations available to the partners network
128134
parent: external
129-
type: audience
135+
kind: audience
136+
137+
- name: external
138+
summary: External
139+
description: Operations available to external consumers
140+
kind: audience
130141
```
131142
132143
---

0 commit comments

Comments
 (0)