Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@ collections:
name: Extension Namespace Registry
output: true
permalink: /registry/:collection/:title
tag-kind:
slug: tag-kind
name: Tag Kind Registry
output: true
permalink: /registry/:collection/:title
exclude:
- Gemfile
- Gemfile.lock
Expand Down
17 changes: 17 additions & 0 deletions _includes/tag-kind-entry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# <a href="..">{{ page.collection }}</a>

## {{ page.slug }} - {{ page.description }}

{{ include.summary }}

{% if page.issue %}
### GitHub Issue

* [#{{ page.issue }}](https://github.com/OAI/OpenAPI-Specification/issues/{{ page.issue }})
{% endif %}

{% if page.remarks %}
### Remarks

{{ page.remarks }}
{% endif %}
13 changes: 13 additions & 0 deletions registries/_tag-kind/audience.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
owner: lornajane
issue:
description: "Tags with `kind: audience` indicate the intended audience for an operation."
layout: default
---

{% capture summary %}
Tags with `kind: audience` indicate the intended audience for an operation.
Common uses might be to tag internal, admin-level, or partner endpoints.
{% endcapture %}

{% include tag-kind-entry.md summary=summary %}
13 changes: 13 additions & 0 deletions registries/_tag-kind/badge.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
owner: lornajane
issue:
description: " Tags with `kind: badge` are applied as visible badges in documentation."
layout: default
---

{% capture summary %}
Tags with `kind: badge` are applied as visible badges in documentation.
It is expected that an operation might have many badges.
{% endcapture %}

{% include tag-kind-entry.md summary=summary %}
13 changes: 13 additions & 0 deletions registries/_tag-kind/nav.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
owner: lornajane
issue:
description: "Tags with `kind: nav` are used in documentation to group operations into sections"
layout: default
---

{% capture summary %}
Tags with `kind: nav` are used in documentation to group operations into sections.
In most cases, an operation only has one tag of this type so it belongs in one section.
{% endcapture %}

{% include tag-kind-entry.md summary=summary %}
1 change: 1 addition & 0 deletions registry/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ children:
- title: Draft Features Registry
- title: Format Registry
- title: Namespace Registry
- title: Tag Kinds Registry
has_toc: false
---

Expand Down
24 changes: 24 additions & 0 deletions registry/tag-kind.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Tag Kinds Registry
layout: default
permalink: /registry/tag-kind/index.html
parent: Registry
---

# Tag Kinds Registry

## Unreleased feature

The `kind` addition to OpenAPI tags is planned for release in OpenAPI 3.2, so support for the values here should not be expected until tools officially support the 3.2 version.

## Contributing

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.

## Values

|Value|Description
|---|---|---|
{% for value in site.tag-kind %}| <a href="./{{ value.slug }}.html">{{ value.slug }}</a> | {{ value.description }} |
{% endfor %}