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: src/oas.md
+42-7
Original file line number
Diff line number
Diff line change
@@ -2691,24 +2691,59 @@ It is not mandatory to have a Tag Object per tag defined in the Operation Object
2691
2691
2692
2692
| Field Name | Type | Description |
2693
2693
| ---- | :----: | ---- |
2694
-
| <a name="tag-name"></a>name | `string` | **REQUIRED**. The name of the tag. |
2694
+
| <a name="tag-name"></a>name | `string` | **REQUIRED**. The name of the tag. Use this value in the `tags` array of an Operation. |
2695
+
| <a name="tag-summary"></a>summary | `string` | A short summary of the tag, used for display purposes. |
2695
2696
| <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. |
2696
2697
| <a name="tag-external-docs"></a>externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. |
2698
+
| <a name="tag-parent"></a>parent | `string` | The `name` of a tag that this tag is nested under. The named tag MUST exist in the API description, and circular references between parent and child tags MUST NOT be used. |
2699
+
| <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. |
2697
2700
2698
2701
This object MAY be extended with [Specification Extensions](#specification-extensions).
2699
2702
2700
2703
##### Tag Object Example
2701
2704
2702
2705
```json
2703
-
{
2704
-
"name": "pet",
2705
-
"description": "Pets operations"
2706
-
}
2706
+
"tags": [
2707
+
{
2708
+
"name": "account-updates",
2709
+
"summary": "Account Updates",
2710
+
"description": "Account update operations",
2711
+
"kind": "nav"
2712
+
},
2713
+
{
2714
+
"name": "partner",
2715
+
"summary": "Partner",
2716
+
"description": "Operations available to the partners network",
2717
+
"parent": "external",
2718
+
"kind": "audience"
2719
+
},
2720
+
{
2721
+
"name": "external",
2722
+
"summary": "External",
2723
+
"description": "Operations available to external consumers",
2724
+
"kind": "audience"
2725
+
}
2726
+
]
2707
2727
```
2708
2728
2709
2729
```yaml
2710
-
name: pet
2711
-
description: Pets operations
2730
+
tags:
2731
+
2732
+
- name: account-updates
2733
+
summary: Account Updates
2734
+
description: Account update operations
2735
+
kind: nav
2736
+
2737
+
- name: partner
2738
+
summary: Partner
2739
+
description: Operations available to the partners network
2740
+
parent: external
2741
+
kind: audience
2742
+
2743
+
- name: external
2744
+
summary: External
2745
+
description: Operations available to external consumers
0 commit comments