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
+36-5Lines changed: 36 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2687,24 +2687,55 @@ It is not mandatory to have a Tag Object per tag defined in the Operation Object
2687
2687
2688
2688
| Field Name | Type | Description |
2689
2689
| ---- | :----: | ---- |
2690
-
| <a name="tag-name"></a>name | `string` | **REQUIRED**. The name of the tag. |
2690
+
| <a name="tag-name"></a>name | `string` | **REQUIRED**. The name of the tag. Use this value in the `tags` array of an Operation. |
2691
+
| <a name="tag-summary"></a>summary | `string` | A short summary of the tag, used for display purposes. |
2691
2692
| <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. |
2692
2693
| <a name="tag-external-docs"></a>externalDocs | [External Documentation Object](#external-documentation-object) | Additional external documentation for this tag. |
2694
+
| <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. |
2695
+
| <a name="tag-kind"></a>kind | `string` | A machine-readable string to categorize what sort of tag it is. Common uses are `nav` for Navigation, `badge` for badges, `internal` for internal APIs, but any string value can be used. |
2693
2696
2694
2697
This object MAY be extended with [Specification Extensions](#specification-extensions).
2695
2698
2696
2699
##### Tag Object Example
2697
2700
2698
2701
```json
2699
2702
{
2700
-
"name": "pet",
2701
-
"description": "Pets operations"
2703
+
"name": "account-updates",
2704
+
"summary": "Account Updates",
2705
+
"description": "Account update operations",
2706
+
"kind": "nav"
2707
+
},
2708
+
{
2709
+
"name": "partner",
2710
+
"summary": "Partner",
2711
+
"description": "Operations available to the partners network",
2712
+
"parent": "external",
2713
+
"kind": "audience"
2714
+
},
2715
+
{
2716
+
"name": "external",
2717
+
"summary": "External",
2718
+
"description": "Operations available to external consumers",
2719
+
"kind": "audience"
2702
2720
}
2703
2721
```
2704
2722
2705
2723
```yaml
2706
-
name: pet
2707
-
description: Pets operations
2724
+
- name: account-updates
2725
+
summary: Account Updates
2726
+
description: Account update operations
2727
+
kind: nav
2728
+
2729
+
- name: partner
2730
+
summary: Partner
2731
+
description: Operations available to the partners network
2732
+
parent: external
2733
+
kind: audience
2734
+
2735
+
- name: external
2736
+
summary: External
2737
+
description: Operations available to external consumers
0 commit comments