Skip to content

Commit 041e29e

Browse files
frankkilcomminsfrankkilcommins
authored
Merge branch 'OAI:gh-pages' into gh-pages
2 parents ec14054 + 33e0aba commit 041e29e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+7216
-7568
lines changed

‎Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ source "https://rubygems.org"
55
gem "jekyll", "~> 4.2"
66
gem "webrick", "~> 1.7"
77
gem "jekyll-remote-theme"
8+
gem "jekyll-include-cache", "~>0.2.1"
89
gem "just-the-docs", "~> 0.4.2"
910

1011
group :jekyll_plugins do

‎Gemfile.lock

+3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ GEM
3131
safe_yaml (~> 1.0)
3232
terminal-table (>= 1.8, < 4.0)
3333
webrick (~> 1.7)
34+
jekyll-include-cache (0.2.1)
35+
jekyll (>= 3.7, < 5.0)
3436
jekyll-remote-theme (0.4.3)
3537
addressable (~> 2.0)
3638
jekyll (>= 3.5, < 5.0)
@@ -81,6 +83,7 @@ PLATFORMS
8183

8284
DEPENDENCIES
8385
jekyll (~> 4.2)
86+
jekyll-include-cache (~> 0.2.1)
8487
jekyll-remote-theme
8588
jekyll-sitemap (~> 1.4)
8689
just-the-docs (~> 0.4.2)

‎README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
# OpenAPI Initiative Registry
22

3-
This site contains the OpenAPI Initiative Registry and content for the HTML versions of the OpenAPI Specification.
3+
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.
44

55
## Registry
66

77
* Proceed to [Registry](./registry/index.html)
88

9-
## The Specification
9+
## OpenAPI Initiative Specifications
10+
11+
| Specification | Markdown Repository | HTML Version |
12+
| :--------------| :------------------ | :------- |
13+
| `OpenAPI Specification` | [View](https://github.com/OAI/OpenAPI-Specification)|[**Latest (3.1.0)**](oas/latest.html), [3.0.3](https://spec.openapis.org/oas/v3.0.3.html), [3.0.2](https://spec.openapis.org/oas/v3.0.2.html), [3.0.1](https://spec.openapis.org/oas/v3.0.1.html), [**3.0.0**](https://spec.openapis.org/oas/v3.0.0.html), [**2.0**](https://spec.openapis.org/oas/v2.0.html)|
14+
| `Workflows Specification` | [View](https://github.com/OAI/sig-workflows) | _coming soon..._
1015

11-
* [Markdown source-of-truth](https://github.com/OAI/OpenAPI-Specification)
12-
* [HTML Specification versions](https://openapis.org/specification)

‎_config.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,9 @@ plugins:
5959
- jekyll-remote-theme
6060
- jekyll-sitemap
6161
aux_links:
62-
"Latest Specification":
62+
"Latest OpenAPI Specification":
6363
- "https://spec.openapis.org/oas/latest.html"
64-
footer_content: "\xA9 2023 OpenAPI Initiative.
64+
footer_content: "\xA9 2024 OpenAPI Initiative.
6565
<br />This work is licensed under the <a rel=\"license\" href=\"https://www.apache.org/licenses/LICENSE-2.0\"\
6666
>Apache 2.0 License</a>. This site is\
6767
\ maintained at <a href=\"https://github.com/OAI/OpenAPI-Specification/tree/gh-pages/\">https://github.com/OAI/OpenAPI-Specification/</a>."

‎_includes/alternative-schema-entry.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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 %}

‎_includes/format-entry.md

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

‎_includes/namespace-entry.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
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 %}

‎api/format.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ parent: API
1010
"description": "{{ page.description }}",
1111
"url": "{{ site.baseurl }}{{ page.url }}",
1212
"owner": "{{ page.owner }}",
13-
"base_type": "{{ page.base_type" }}"
13+
"base_type": ["{{ page.base_type | join: '", "' }}"]
1414
}{% unless forloop.last %},{% endunless %}
1515
{% endfor %}
1616
}

‎index.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ layout: default
66

77
# OpenAPI Initiative Registry
88

9-
This site contains the OpenAPI Initiative Registry and content for the HTML versions of the OpenAPI Specification.
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.
1010

1111
## Registry
1212

1313
* Proceed to [Registry](./registry/index.html)
1414

15-
## The Specification
15+
## OpenAPI Initiative Specifications
1616

17-
* [Markdown source-of-truth](https://github.com/OAI/OpenAPI-Specification)
18-
* [HTML Specification version](oas/latest.html)
17+
| Specification | Markdown Repository | HTML Version |
18+
| :--------------| :------------------ | :------- |
19+
| `OpenAPI Specification` | [View](https://github.com/OAI/OpenAPI-Specification)|[View](oas/latest.html)|
20+
| `Workflows Specification` | [View](https://github.com/OAI/sig-workflows) | _coming soon..._

‎oas/latest.html

+1,159-1,159
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)