You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: proposals/2024-09-01-Tags-Improvement.md
+23-12Lines changed: 23 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -33,7 +33,7 @@ On a personal note, I work for a tool vendor and was proposing these changes int
33
33
34
34
### Supporting evidence
35
35
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:
37
37
38
38
- 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)
39
39
- 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
102
102
103
103
```json
104
104
{
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"
109
109
},
110
110
{
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"
116
122
}
117
123
```
118
124
119
125
```yaml
120
126
- name: account-updates
121
127
summary: Account Updates
122
128
description: Account update operations
123
-
type: nav
129
+
kind: nav
124
130
125
131
- name: partner
126
132
summary: Partner
127
133
description: Operations available to the partners network
128
134
parent: external
129
-
type: audience
135
+
kind: audience
136
+
137
+
- name: external
138
+
summary: External
139
+
description: Operations available to external consumers
0 commit comments