Skip to content

Commit dac0d3a

Browse files
committed
Add the tag kinds registry and the intial values
1 parent 4a934e8 commit dac0d3a

File tree

7 files changed

+82
-0
lines changed

7 files changed

+82
-0
lines changed

_config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ collections:
3838
name: Extension Namespace Registry
3939
output: true
4040
permalink: /registry/:collection/:title
41+
tag-kind:
42+
slug: tag-kind
43+
name: Tag Kind Registry
44+
output: true
45+
permalink: /registry/:collection/:title
4146
exclude:
4247
- Gemfile
4348
- Gemfile.lock

_includes/tag-kind-entry.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# <a href="..">{{ page.collection }}</a>
2+
3+
## {{ page.slug }} - {{ page.description }}
4+
5+
{{ include.summary }}
6+
7+
{% if page.issue %}
8+
### GitHub Issue
9+
10+
* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
11+
{% endif %}
12+
13+
{% if page.remarks %}
14+
### Remarks
15+
16+
{{ page.remarks }}
17+
{% endif %}

registries/_tag-kind/audience.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
owner: lornajane
3+
issue:
4+
description: "Tags with `kind: audience` indicate the intended audience for an operation."
5+
layout: default
6+
---
7+
8+
{% capture summary %}
9+
Tags with `kind: audience` indicate the intended audience for an operation.
10+
Common uses might be to tag internal, admin-level, or partner endpoints.
11+
{% endcapture %}
12+
13+
{% include tag-kind-entry.md summary=summary %}

registries/_tag-kind/badge.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
owner: lornajane
3+
issue:
4+
description: " Tags with `kind: badge` are applied as visible badges in documentation."
5+
layout: default
6+
---
7+
8+
{% capture summary %}
9+
Tags with `kind: badge` are applied as visible badges in documentation.
10+
It is expected that an operation might have many badges.
11+
{% endcapture %}
12+
13+
{% include tag-kind-entry.md summary=summary %}

registries/_tag-kind/nav.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
owner: lornajane
3+
issue:
4+
description: "Tags with `kind: nav` are used in documentation to group operations into sections"
5+
layout: default
6+
---
7+
8+
{% capture summary %}
9+
Tags with `kind: nav` are used in documentation to group operations into sections.
10+
In most cases, an operation only has one tag of this tag so it belongs in one section.
11+
{% endcapture %}
12+
13+
{% include tag-kind-entry.md summary=summary %}

registry/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ children:
88
- title: Draft Features Registry
99
- title: Format Registry
1010
- title: Namespace Registry
11+
- title: Tag Kinds Registry
1112
has_toc: false
1213
---
1314

registry/tag-kind.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Tag Kinds Registry
3+
layout: default
4+
permalink: /registry/tag-kind/index.html
5+
parent: Registry
6+
---
7+
8+
# Tag Kinds Registry
9+
10+
## Contributing
11+
12+
Please raise a [Pull-Request](https://github.com/OAI/OpenAPI-Specification/pulls) or [Issue](https://github.com/OAI/OpenAPI-Specification/issues) to contribute or discuss a registry value.
13+
14+
## Values
15+
16+
|Value|Description
17+
|---|---|---|
18+
{% for value in site.tag-kind %}| <a href="./{{ value.slug }}.html">{{ value.slug }}</a> | {{ value.description }} |
19+
{% endfor %}
20+

0 commit comments

Comments
 (0)