Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move gh-pages into main branch #3868

Closed
wants to merge 188 commits into from
Closed
Show file tree
Hide file tree
Changes from 187 commits
Commits
Show all changes
188 commits
Select commit Hold shift + click to select a range
5051498
Initial commit
MikeRalphson Jun 14, 2018
52affa2
Add index.md, v2.0 and v3.0.0
MikeRalphson Jun 14, 2018
68215a3
Create CNAME
webron Jul 11, 2018
74ee685
Deploy MikeRalphson/OpenAPI-Specification to github.com/MikeRalphson/…
traviscibot Sep 20, 2018
1d5c5cb
draft registry content
MikeRalphson Nov 28, 2018
4d03d09
Merge pull request #1762 from MikeRalphson/registry
webron Dec 6, 2018
e7f201c
Update index.md with clearer title and desc.
MikeRalphson Dec 8, 2018
fa84486
Merge branch 'gh-pages' of https://github.com/mikeralphson/openapi-sp…
MikeRalphson Dec 8, 2018
81409a6
Add v3.0.2 respec/html
MikeRalphson Jan 2, 2019
ba51031
Merge pull request #1796 from MikeRalphson/add3.0.2
webron Jan 2, 2019
9cd199d
Merge pull request #1774 from MikeRalphson/gh-pages
webron Jan 10, 2019
523ad57
Hand-craft API templates for leaner output
MikeRalphson Jan 14, 2019
5a4d660
Merge pull request #1808 from MikeRalphson/gh-pages
webron Jan 31, 2019
b24e2fd
gh-pages: add v3.0.3.html (#2151)
MikeRalphson Feb 21, 2020
f0a6bef
gh-pages: don't mix https and http content (toc) (#2154)
MikeRalphson Feb 22, 2020
62d0c05
gh-pages: add v3.1.0.html (#2464)
MikeRalphson Feb 16, 2021
dd98272
Make 3.1 schemas retrievable from their $ids
jdesrosiers Mar 22, 2021
2f56ee7
Merge pull request #2509 from jdesrosiers/gh-pages
MikeRalphson Mar 25, 2021
b92609b
fix: regenerate respec versions, refs #2488 (#2573)
MikeRalphson May 13, 2021
bf82a1d
iAdd v3.1 2021-05-20 schemas to website
jdesrosiers May 20, 2021
8193ef8
Merge pull request #2587 from jdesrosiers/deploy-2021-05-20-schema
MikeRalphson May 27, 2021
5948c36
Add v3.1 2021-04-15 schemas to website (#2545)
jdesrosiers May 27, 2021
c0e7db7
gh-pages: change text of Abstract heading (#2606)
MikeRalphson Jun 10, 2021
086a633
Update ReSpec versions (#2615)
github-actions[bot] Jun 10, 2021
bf1b16b
Release 2021-09-28 schemas for v3.0 and v3.1 (#2732)
jdesrosiers Oct 7, 2021
88b7cb0
Fix typo in URL for 3.0 schema release (#2741)
jdesrosiers Oct 7, 2021
18717ad
Add "latest" URLs for downloading meta schemas (#2747)
jdesrosiers Nov 11, 2021
54da8c5
Fix "latest" symlink for 3.0 schema (#2810)
jdesrosiers Dec 2, 2021
68ed2e4
Added formats to the registry as defined by OpenAPI v3 (#2857)
darrelmiller Feb 3, 2022
2ac4417
Add version 2022-02-27 of v3.1 schemas (#2889)
jdesrosiers Mar 10, 2022
b4cc425
Update ReSpec versions (#2836)
github-actions[bot] Mar 10, 2022
452b94d
Publish 3.1 schemas for version 2022-10-07 (#3043)
jdesrosiers Oct 13, 2022
2c2162e
Add new extension namespace registry (#3107)
darrelmiller Jan 26, 2023
b5715b1
Reserve x-sap- namespace for SAP extensions (#3151)
pavelkornev Feb 9, 2023
460a67d
Make links relative
handrews Mar 1, 2023
9fbab3e
Remove extra "/" from URL
handrews Mar 2, 2023
e482531
Need to go up a level for the rss URL
handrews Mar 2, 2023
6c3caaa
Merge pull request #3179 from handrews/relative
whitlockjc Mar 3, 2023
7592eb8
adds missing formats in the registry (#3167)
baywet Mar 6, 2023
83844b8
- adds int16 format (#3186)
baywet Mar 16, 2023
660331f
- adds a char format description (#3185)
baywet Mar 16, 2023
94c8821
- adds a base64url format description (#3184)
baywet Mar 16, 2023
003ee43
Update ReSpec versions (#3203)
github-actions[bot] Mar 16, 2023
1232ed6
gh-pages: add Dockerfile for local dev/testing (#3201)
MikeRalphson Mar 18, 2023
1b88087
- adds decimal format (#3190)
baywet Mar 21, 2023
f915f09
Update decimal.md (#3208)
ralfhandl Mar 21, 2023
2a862a7
Comma-separated base_type list (#3210)
ralfhandl Mar 23, 2023
ee33a0f
[gh-pages] reskin registry site and prep for release (#3212)
MikeRalphson Mar 23, 2023
dace7d0
Register format decimal128 (#3209)
ralfhandl Mar 30, 2023
cacc239
Add media-range format to registry (#3238)
jdesrosiers Apr 13, 2023
f8f3d25
Update int64.md (#3232)
ralfhandl Apr 13, 2023
4c5c4be
Add format for imf-fixdate used in HTTP headers (#3285)
mikekistler May 29, 2023
6f1aebf
Replace imf-fixdate with the more general and useful http-date (#3290)
mikekistler Jun 2, 2023
44cf3d7
adds formats registry considerations (#3204)
baywet Jul 25, 2023
8cb215c
Add structured fields primitive types to format registry
mikekistler Oct 3, 2023
515bbc3
De-emphasize the ABNF
mikekistler Oct 5, 2023
6b74070
Add source info and address PR comments
mikekistler Oct 13, 2023
e2aeb00
Update ReSpec versions (#3410)
github-actions[bot] Oct 25, 2023
1d8ce42
Add double-int to format registry (#3381)
mikekistler Nov 16, 2023
3c5991b
fix types to use an array rather than a string when multiple types ar…
karenetheridge Jan 7, 2024
5c32781
Merge pull request #3491 from karenetheridge/ether/fix-format-types
lornajane Jan 24, 2024
530015e
Generalize description of password data type
mgrafl Jan 27, 2024
5022402
Update ReSpec versions (#3520)
github-actions[bot] Feb 14, 2024
c6fa479
Initial prep for multiple specifications under OAI (#3571)
frankkilcommins Feb 15, 2024
ce69f1c
fix: broken docker build (#3573)
miqui Feb 15, 2024
ae1528c
Merge pull request #3531 from mgrafl/patch-2
earth2marsh Feb 22, 2024
a5fe410
Address PR reivew comments
mikekistler Feb 25, 2024
11d0ae5
Merge pull request #3390 from mikekistler/structured-fields
lornajane Feb 29, 2024
166855e
Update ReSpec versions
earth2marsh Mar 6, 2024
abd17f2
Merge pull request #3622 from OAI/update-respec-version
handrews Mar 21, 2024
94a087a
Set base_type to array
Bellangelo May 7, 2024
a1c4b7a
join base_type
Bellangelo May 7, 2024
30d42b7
Format base_type as a JSON array
Bellangelo May 7, 2024
b42916f
Last property should not have a comma
Bellangelo May 8, 2024
436c083
Keep common things into a single template
Bellangelo May 10, 2024
e14e81d
Merge pull request #3789 from Bellangelo/fix-base-type-array-joining
handrews May 11, 2024
8cb7ddb
Style fix
Bellangelo May 12, 2024
795069c
Update ReSpec versions
lornajane May 16, 2024
43c324a
Merge pull request #3688 from OAI/update-respec-version
handrews May 20, 2024
d169e64
Merge pull request #3799 from Bellangelo/encapsulate-page-layout
handrews May 20, 2024
59062b1
Jekyll does not load variables in front-matter
Bellangelo May 20, 2024
73ad0ea
Merge pull request #3825 from Bellangelo/jekyll-does-not-load-variabl…
handrews May 20, 2024
09439bd
Capture allows the usage of curly braces
Bellangelo May 20, 2024
7ec03d3
Merge pull request #3826 from Bellangelo/fix-shcema-layout
handrews May 20, 2024
082e1d1
Encapsulate page layout for extensions
Bellangelo May 20, 2024
5821f2a
Fix closing tag
Bellangelo May 20, 2024
19a55e6
Publish extension registry
Bellangelo May 20, 2024
ccbf6a8
Re-enable page build
Bellangelo May 20, 2024
599f265
Encapsulate Microsoft page layout
Bellangelo May 20, 2024
bec1c58
Encapsulate Draft page layout
Bellangelo May 20, 2024
a1c7fcc
Encapsulate SAP page layout
Bellangelo May 20, 2024
c03b1bf
Merge branch 'encapsulate-namespaces-page-layout' into gh-pages
Bellangelo May 20, 2024
26fa6be
Fix link
Bellangelo May 20, 2024
b816b0c
Merge branch 'encapsulate-namespaces-page-layout' into gh-pages
Bellangelo May 20, 2024
f214858
Encapsulate base64 url
Bellangelo May 20, 2024
0d4958f
Encapsulate binary
Bellangelo May 20, 2024
76fed8f
Encapsulate byte
Bellangelo May 20, 2024
4beb774
Encapsulate char
Bellangelo May 20, 2024
caed1e6
Encapsulate commonmark
Bellangelo May 20, 2024
02e0a7f
Encapsulate date
Bellangelo May 20, 2024
91d71ce
Encapsulate date-time
Bellangelo May 20, 2024
8f02b4f
Encapsulate decimal
Bellangelo May 20, 2024
2f23b2a
Encapsulate decimal128
Bellangelo May 20, 2024
541f872
Encapsulate double
Bellangelo May 20, 2024
dc64008
Encapsulate double-int
Bellangelo May 20, 2024
b64a673
Merge branch 'encapsulate-format-page-layout-part1' into gh-pages
Bellangelo May 20, 2024
7391f99
Fix variable
Bellangelo May 20, 2024
59ee866
Merge branch 'encapsulate-format-page-layout-part1' into gh-pages
Bellangelo May 20, 2024
183ddc0
Merge pull request #3829 from Bellangelo/encapsulate-namespaces-page-…
handrews May 20, 2024
81015d9
Merge pull request #3830 from Bellangelo/encapsulate-format-page-layo…
handrews May 20, 2024
5e642a7
Encapsulate duration
Bellangelo May 21, 2024
28448dd
Encapsulate email
Bellangelo May 21, 2024
d564ea9
Encapsulate float
Bellangelo May 21, 2024
b80c924
Encapsulate hostname
Bellangelo May 21, 2024
e94c218
Encapsulate html
Bellangelo May 21, 2024
aea25b5
Encapsulate http-date
Bellangelo May 21, 2024
57e592a
Encapsulate idn-email
Bellangelo May 21, 2024
fe55e06
Encapsulate idn-hostname
Bellangelo May 21, 2024
50d1c82
Encapsulate int8
Bellangelo May 21, 2024
b5eeda5
Encapsulate int16
Bellangelo May 21, 2024
21f6d4d
Encapsulate int32
Bellangelo May 21, 2024
f621814
Encapsulate int64
Bellangelo May 21, 2024
6710432
Merge branch 'encapsulate-format-page-layout-part2' into gh-pages
Bellangelo May 21, 2024
fa3aa79
Fix joining arrays
Bellangelo May 21, 2024
8582ccf
Fix joining arrays
Bellangelo May 21, 2024
8ea8acf
Merge branch 'encapsulate-format-page-layout-part2' into gh-pages
Bellangelo May 21, 2024
947d226
Encapsulate ipv4
Bellangelo May 21, 2024
1bc08d1
Encapsulate ipv6
Bellangelo May 21, 2024
f23438a
Encapsulate iri
Bellangelo May 21, 2024
6f137bc
Encapsulate iri-reference
Bellangelo May 21, 2024
5093653
Encapsulate json-pointer
Bellangelo May 21, 2024
d014e85
Encapsulate media-range
Bellangelo May 21, 2024
45f311e
Encapsulate password
Bellangelo May 21, 2024
0728946
Encapsulate regex
Bellangelo May 21, 2024
843e501
Encapsulate relative-json-pointer
Bellangelo May 21, 2024
1fce917
Encapsulate binary
Bellangelo May 21, 2024
7a2ed2b
Merge branch 'encapsulate-format-page-layout-part3' into gh-pages
Bellangelo May 21, 2024
9f9dc8a
Encapsulate boolean
Bellangelo May 21, 2024
a4222bf
Encapsulate decimal
Bellangelo May 21, 2024
5b840b0
Encapsulate integer
Bellangelo May 21, 2024
2bcc825
Encapsulate string
Bellangelo May 21, 2024
209d991
Encapsulate sf-token
Bellangelo May 21, 2024
83fae1b
Encapsulate time
Bellangelo May 21, 2024
25ca2c0
Encapsulate uint8
Bellangelo May 21, 2024
7b191ce
Encapsulate uri
Bellangelo May 21, 2024
4859786
Encapsulate uri-reference
Bellangelo May 21, 2024
480d0d6
Encapsulate uri-template
Bellangelo May 21, 2024
2cb5fae
Encapsulate uuid
Bellangelo May 21, 2024
1e30eee
Merge branch 'encapsulate-format-page-layout-part4' into gh-pages
Bellangelo May 21, 2024
6782837
Merge pull request #3831 from Bellangelo/encapsulate-format-page-layo…
handrews May 21, 2024
c9af53a
Merge pull request #3832 from Bellangelo/encapsulate-format-page-layo…
handrews May 21, 2024
33e0aba
Merge pull request #3833 from Bellangelo/encapsulate-format-page-layo…
handrews May 21, 2024
0b9a8d5
Update ReSpec versions
frankkilcommins May 23, 2024
ec14054
Merge pull request #4 from frankkilcommins/update-respec-version
frankkilcommins May 23, 2024
041e29e
Merge branch 'OAI:gh-pages' into gh-pages
frankkilcommins May 23, 2024
5d35d01
Update ReSpec versions
frankkilcommins May 23, 2024
d845ba3
Merge pull request #5 from frankkilcommins/update-respec-version
frankkilcommins May 23, 2024
aecf331
Update ReSpec versions (#6)
frankkilcommins May 23, 2024
3f1f7d2
feat: rendering of the Arazzo Specification
frankkilcommins May 23, 2024
3840aa3
chore: use new repo url
frankkilcommins May 23, 2024
9091784
chore: dedicate respec script
frankkilcommins May 23, 2024
37cd094
Update ReSpec versions
lornajane May 23, 2024
d975a55
Merge pull request #3828 from Bellangelo/encapsulate-page-layout-for-…
handrews May 23, 2024
c01d8cf
Merge pull request #3842 from frankkilcommins/gh-pages
lornajane May 23, 2024
eed6b7e
Merge pull request #3844 from OAI/update-respec-version
handrews May 23, 2024
4aa1a67
Update ReSpec versions
frankkilcommins May 24, 2024
ea03525
Merge pull request #3851 from OAI/update-respec-version
handrews May 24, 2024
4c1810a
Merge branch 'OAI:gh-pages' into gh-pages
Bellangelo May 30, 2024
137f0bc
Move files under the new folder structure
Bellangelo May 30, 2024
a541fa1
Github accept root folder and /docs only
Bellangelo May 30, 2024
994c8e8
Merge branch 'gh-pages'
Bellangelo May 30, 2024
02448a8
Update pull request update
Bellangelo May 30, 2024
2448ba0
Update respec action
Bellangelo May 30, 2024
82ed239
Update registry description
Bellangelo May 30, 2024
671fb76
Update site config
Bellangelo May 30, 2024
dc6f446
Fix path
Bellangelo May 31, 2024
137a669
Create path first
Bellangelo May 31, 2024
f582f1f
Skip markdown validation on docs update
Bellangelo May 31, 2024
e839d4e
Skip actions on docs update
Bellangelo May 31, 2024
d4a13fe
Do not update respec when docs are updated
Bellangelo May 31, 2024
3afd47d
test
Bellangelo May 31, 2024
505b795
Remove outdated comment and test commit
Bellangelo May 31, 2024
0eba3e5
LICENSE exists in the root directory
Bellangelo Jun 4, 2024
83770b9
Remove unnecessary ignores
Bellangelo Jun 4, 2024
38e249c
Set the TSC group as PR reviewers
Bellangelo Jun 4, 2024
e7a5999
Build site without the deploy folder
Bellangelo Jun 4, 2024
fbee8d4
No need to specify a path
Bellangelo Jun 4, 2024
9d361f6
Remove files from old implementation
Bellangelo Jun 5, 2024
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
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ branch and file:
* 3.2.0 spec: v3.2.0-dev branch, versions/3.2.0.md
* 3.0 schema: main branch, schemas/v3.0/...
* 3.1 schema: main branch, schemas/v3.1/...
* registry templates: gh-pages branch, registry/...
* registry contents: gh-pages branch, registries/...
* registry templates: main branch, docs/registry/...
* registry contents: main branch, docs/registries/...

Note that we do not accept changes to published specifications.
-->
2 changes: 2 additions & 0 deletions .github/workflows/convert-examples-to-json.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ on:
push:
branches:
- main
paths-ignore:
- 'docs/**'

jobs:
yaml2json:
Expand Down
14 changes: 5 additions & 9 deletions .github/workflows/respec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,16 @@ name: respec

#
# This workflow updates the respec 'pretty' rendered versions of the spec
# on the gh-pages branch when the corresponding markdown files change.
# on the main branch when the corresponding markdown files change.
#

# run this on push to main
on:
push:
branches:
- main
paths-ignore:
- 'docs/**'
workflow_dispatch: {}

jobs:
Expand All @@ -32,11 +34,6 @@ jobs:
- name: Install dependencies
run: npm ci

- uses: actions/checkout@v4 # checkout gh-pages branch
with:
ref: gh-pages
path: deploy

- name: run main script
run: scripts/md2html/build.sh
ralfhandl marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -45,11 +42,10 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: update-respec-version
base: gh-pages
base: main
delete-branch: true
path: deploy
labels: Housekeeping
reviewers: webron,darrelmiller
reviewers: TSC
title: Update ReSpec versions
commit-message: Update ReSpec versions
signoff: true
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/schema-tests.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,12 @@ name: schema-test

# run this on push to any branch and creation of pull-requests
on:
push: {}
pull_request: {}
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'
workflow_dispatch: {}

jobs:
Expand Down
9 changes: 7 additions & 2 deletions .github/workflows/validate-markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,16 @@ name: validate-markdown
#

# run this on push to any branch and creation of pull-requests
on: [push, pull_request]
on:
push:
paths-ignore:
- 'docs/**'
pull_request:
paths-ignore:
- 'docs/**'

jobs:
mdv:

runs-on: ubuntu-latest

steps:
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@
target
atlassian-ide-plugin.xml
node_modules/
deploy/
history
Gemfile.lock
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_site/
1 change: 1 addition & 0 deletions docs/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
spec.openapis.org
43 changes: 43 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing

## Building the site

The registy site uses [jekyll](https://jekyllrb.com/), a Ruby based static site generator, with the Dinky theme.

### Docker dev

You can use the following Docker command to build and serve the site:

```shell
docker build . -t oas-spec/latest
docker run -v $(pwd):/site -p 4000:4000 oas-spec/latest
```

### Local Ruby dev

You will need to set up Ruby locally to run the server and see your changes.

``` bash
gem install bundler
bundle install
```

With all the gems (dependencies) installed, you can launch the jekyll server.

``` bash
bundle exec jekyll serve
```

It will show output like this, and you can grab the Server address and open it in your browser.

```
Configuration file: /site/_config.yml
Source: /site
Destination: /site/_site
Incremental build: disabled. Enable with --incremental
Generating...
done in 3.609 seconds.
Auto-regeneration: enabled for '/site'
Server address: http://0.0.0.0:4000
```

13 changes: 13 additions & 0 deletions docs/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM bretfisher/jekyll-serve

WORKDIR /site

# install dependencies
COPY Gemfile Gemfile.lock ./
RUN bundle install

# install the site
COPY . .

EXPOSE 4000
CMD [ "bundle", "exec", "jekyll", "serve", "--host", "0.0.0.0" ]
13 changes: 13 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# frozen_string_literal: true

source "https://rubygems.org"

gem "jekyll", "~> 4.2"
gem "webrick", "~> 1.7"
gem "jekyll-remote-theme"
gem "jekyll-include-cache", "~>0.2.1"
gem "just-the-docs", "~> 0.4.2"

group :jekyll_plugins do
gem "jekyll-sitemap", "~> 1.4"
end
97 changes: 97 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.2.2)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5)
forwardable-extended (2.6.0)
google-protobuf (3.22.2)
google-protobuf (3.22.2-x64-mingw-ucrt)
http_parser.rb (0.8.0)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
jekyll (4.3.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (>= 2.0, < 4.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3, >= 2.3.1)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (>= 0.3.6, < 0.5)
pathutil (~> 0.9)
rouge (>= 3.0, < 5.0)
safe_yaml (~> 1.0)
terminal-table (>= 1.8, < 4.0)
webrick (~> 1.7)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-remote-theme (0.4.3)
addressable (~> 2.0)
jekyll (>= 3.5, < 5.0)
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (3.0.0)
sass-embedded (~> 1.54)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.4.2)
jekyll (>= 3.8.5)
jekyll-seo-tag (>= 2.0)
rake (>= 12.3.1)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.4)
listen (3.8.0)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.1)
rake (13.0.6)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.30.0)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass-embedded (1.58.3)
google-protobuf (~> 3.21)
rake (>= 10.0.0)
sass-embedded (1.58.3-x64-mingw-ucrt)
google-protobuf (~> 3.21)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.4.2)
webrick (1.8.1)

PLATFORMS
ruby
x64-mingw-ucrt

DEPENDENCIES
jekyll (~> 4.2)
jekyll-include-cache (~> 0.2.1)
jekyll-remote-theme
jekyll-sitemap (~> 1.4)
just-the-docs (~> 0.4.2)
webrick (~> 1.7)

BUNDLED WITH
2.5.10
15 changes: 15 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# OpenAPI Initiative Registry

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.

## Registry

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

## OpenAPI Initiative Specifications

| Specification | Markdown Repository | HTML Version |
| :--------------| :------------------ | :------- |
| `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)|
| `Arazzo Specification` | [View](https://github.com/OAI/Arazzo-Specification) | [1.0.0](https://spec.openapis.org/arazzo/v1.0.0.html)|

68 changes: 68 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# theme: just-the-docs
remote_theme: just-the-docs/just-the-docs
color_scheme: oai
title: OpenAPI Initiative Registry
description: Extensible data value repository
show_downloads: true
collections_dir: /registries
collections:
posts:
hidden: true
object:
slug: object
name: Object Registry
hidden: true
format:
slug: format
name: Format Registry
output: true
permalink: /registry/:collection/:title
extension:
slug: extension
name: Specification Extension Registry
output: true
permalink: /registry/:collection/:title
draft-feature:
slug: draft-feature
name: Draft Features Registry
output: true
permalink: /registry/:collection/:title
alternative-schema:
slug: alternative-schema
name: Alternative Schema Type Registry
output: true
permalink: /registry/:collection/:title
namespace:
slug: namespace
name: Extension Namespace Registry
output: true
permalink: /registry/:collection/:title
exclude:
- Gemfile
- Gemfile.lock
- tmp
- vendor/bundle
#just_the_docs:
# collections:
# draft-feature:
# name: Draft features
# alternative-schema:
# name: Alternative schemas
# namespace:
# name: Extension namespaces
# draft-feature:
# name: Draft features
# format:
# name: Formats
plugins:
- jekyll-remote-theme
- jekyll-sitemap
aux_links:
"Latest OpenAPI Specification":
- "https://spec.openapis.org/oas/latest.html"
"Latest Arazzo Specification":
- "https://spec.openapis.org/arazzo/latest.html"
footer_content: "\xA9 2024 OpenAPI Initiative.
<br />This work is licensed under the <a rel=\"license\" href=\"https://www.apache.org/licenses/LICENSE-2.0\"\
>Apache 2.0 License</a>. This site is\
\ maintained at <a href=\"https://github.com/OAI/OpenAPI-Specification/tree/main/docs/\">https://github.com/OAI/OpenAPI-Specification/</a>."
11 changes: 11 additions & 0 deletions docs/_includes/alternative-schema-entry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# <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 %}
16 changes: 16 additions & 0 deletions docs/_includes/extension-entry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# <a href="..">{{ page.collection }}</a>

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

{{ include.summary }}

### Schema

```yaml
{{page.schema}}
```

### Example

{{ include.example }}

Loading