Skip to content

Commit 7cabdd7

Browse files
committed
Generalize registry site to publications
The spec site main page had gotten a bit muddled. This organizes it into three distinct sections (Specifications, Registries, and Non-normative JSON Schemas) and adds an intro paragraph that links to each section as well as the Learn and Tools site. The reason for moving the schemas is that I almost couldn't find the Overlay specification (I added Overlay to the shortcut links at the top as well as it was missing). The registries are in-between as they are less-well-known, and I added shortcuts to the individual registries as it made the sections feel more similar. I renamed the overall site "Publications" instead of "Registry", as it does a lot more now. It could be "Specifications" if we would rather stick with the "spec site" terminology.
1 parent f1ce6c2 commit 7cabdd7

File tree

2 files changed

+33
-17
lines changed

2 files changed

+33
-17
lines changed

_config.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# theme: just-the-docs
22
remote_theme: just-the-docs/just-the-docs
33
color_scheme: oai
4-
title: OpenAPI Initiative Registry
5-
description: Extensible data value repository
4+
title: OpenAPI Initiative Publications
5+
description: Specifications, registries, and schemas
66
show_downloads: true
77
excerpt_separator: ""
88
collections_dir: /registries
@@ -63,6 +63,8 @@ aux_links:
6363
- "https://spec.openapis.org/oas/latest.html"
6464
"Latest Arazzo Specification":
6565
- "https://spec.openapis.org/arazzo/latest.html"
66+
"Latest Overlay Specification":
67+
- "https://spec.openapis.org/overlay/latest.html"
6668
footer_content: "\xA9 2024 OpenAPI Initiative.
6769
<br />This work is licensed under the <a rel=\"license\" href=\"https://www.apache.org/licenses/LICENSE-2.0\"\
6870
>Apache 2.0 License</a>. This site is\

index.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,43 @@ description: HTML Spec. and extensible registry
44
layout: default
55
---
66

7-
# OpenAPI Initiative Registry
7+
# OpenAPI Initiative Publications
88

9-
This site contains the OpenAPI Initiative Registry and content for the HTML versions of specifications managed by the OpenAPI Initiative such as the OpenAPI Specification and the Arazzo Specification.
9+
This site contains the authoritative HTML renderings of the OpenAPI Initiative's [specifications](#specifications) and [extension registries](#registries), as well as official (but non-[normative](https://en.wikipedia.org/wiki/Normativity#Standards_documents)) [schemas](#non-normative-json-schemas) for those specifications that provide them.
1010

11-
## Registry
11+
Please see the [Learn OpenAPI](https://learn.openapis.org) site for additional documentation and [examples](https://learn.openapis.org/examples/), and the [OpenAPI Tooling](https://tools.openapis.org/) site for community-provided lists of tools implementing the specifications.
1212

13-
* Proceed to [Registry](./registry/index.html)
13+
## Specifications
1414

15-
## Arazzo Specification
16-
17-
### Versions
15+
### Arazzo Specification
1816

1917
{% include specification-version-list.md specification="arazzo" %}
2018

21-
## OpenAPI Specification
22-
23-
### Versions
19+
### OpenAPI Specification
2420

2521
{% include specification-version-list.md specification="oas" %}
2622

27-
### Non-Normative JSON Schemas
23+
### Overlay Specification
24+
25+
{% include specification-version-list.md specification="overlay" %}
26+
27+
## Registries
28+
29+
The [Registry Page](./registry/index.html) includes documentation as well as API and RSS access for all registries
30+
31+
Registry shortcuts:
32+
{% for registry in site.collections %}{% unless registry.hidden %}
33+
* <a href="registry/{{ registry.slug }}">{{ registry.name }}</a>{% endunless %}{% endfor %}
34+
35+
## Non-Normative JSON Schemas
36+
37+
_Note that while schemas can catch many errors, they are not guaranteed to catch all specification violations. In the event of a disagreement between the schemas and the corresponding specificaton text, the specification text is presumed to be correct._
38+
39+
### Arazzo Schemas
40+
41+
_TBD_
42+
43+
### OpenAPI Specification Schemas
2844

2945
{% assign schema_files = site.static_files | where: "extname", "" | sort: "path" | reverse %}
3046
{% assign last_version = "" %}
@@ -50,8 +66,6 @@ This site contains the OpenAPI Initiative Registry and content for the HTML vers
5066
{%- endif -%}
5167
{%- endfor %}
5268

53-
## Overlay Specification
54-
55-
### Versions
69+
### Overlay Specification Schemas
5670

57-
{% include specification-version-list.md specification="overlay" %}
71+
_TBD_

0 commit comments

Comments
 (0)