Skip to content

Commit f6ee706

Browse files
authored
Merge pull request #4226 from handrews/spec-title
gh-pages: Generalize registry site to publications
2 parents f1ce6c2 + 20893ba commit f6ee706

File tree

2 files changed

+39
-19
lines changed

2 files changed

+39
-19
lines changed

_config.yml

Lines changed: 6 additions & 4 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
@@ -59,10 +59,12 @@ plugins:
5959
- jekyll-remote-theme
6060
- jekyll-sitemap
6161
aux_links:
62-
"Latest OpenAPI Specification":
62+
"Latest OpenAPI Spec":
6363
- "https://spec.openapis.org/oas/latest.html"
64-
"Latest Arazzo Specification":
64+
"Latest Arazzo Spec":
6565
- "https://spec.openapis.org/arazzo/latest.html"
66+
"Latest Overlay Spec":
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: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,47 @@ 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
44+
45+
Note that the OAS 3.1 `schema/YYYY-MM-DD` schema does _not_ validate the Schema Object, as it makes no assumptions about the JSON Schema dialect in use. The OAS 3.1 `schema-base/YYYY-MM-DD` schema _does_ validate the Schema Object, and requires that if `jsonSchemaDialect` or `$schema` are present, that they use the appropriate `dialect/YYYY-MM-DD`. The name `schema-base` comes from the JSON Schema dialect including the OAS extensions being referred to as the "base dialect" in the specification.
46+
47+
See [issue #4147](https://github.com/OAI/OpenAPI-Specification/issues/4147) for discussion of other possible JSON Schema dialect options, [issue #4152](https://github.com/OAI/OpenAPI-Specification/issues/4152) for programmatic access to the latest schemas, and [issue #4141](https://github.com/OAI/OpenAPI-Specification/issues/4141) for discussions on possibly providing linting schemas that could catch likely problems that do not directly violate the specification.
2848

2949
{% assign schema_files = site.static_files | where: "extname", "" | sort: "path" | reverse %}
3050
{% assign last_version = "" %}
@@ -50,8 +70,6 @@ This site contains the OpenAPI Initiative Registry and content for the HTML vers
5070
{%- endif -%}
5171
{%- endfor %}
5272

53-
## Overlay Specification
73+
### Overlay Specification Schemas
5474

55-
### Versions
56-
57-
{% include specification-version-list.md specification="overlay" %}
75+
_TBD_

0 commit comments

Comments
 (0)