Skip to content

Commit 8e7ba91

Browse files
handrewshandrews
committed
Attempt at a rendering of the spec site
1 parent 100c750 commit 8e7ba91

File tree

194 files changed

+111012
-0
lines changed

Some content is hidden

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

194 files changed

+111012
-0
lines changed

‎renderings/oas/site/CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
spec.openapis.org

‎renderings/oas/site/CONTRIBUTING.md‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
# Contributing
2+
3+
## Building the site
4+
5+
The registry site uses [jekyll](https://jekyllrb.com/),
6+
a Ruby based static site generator, with the Dinky theme.
7+
8+
### Docker dev
9+
10+
You can use the following Docker command to build and serve the site:
11+
12+
```shell
13+
docker build . -t oas-spec/latest
14+
docker run -v $(pwd):/site -p 4000:4000 oas-spec/latest
15+
```
16+
17+
### Local Ruby dev
18+
19+
You will need to set up Ruby locally to run the server and see your changes.
20+
21+
``` bash
22+
gem install bundler
23+
bundle install
24+
```
25+
26+
With all the gems (dependencies) installed, you can launch the jekyll server.
27+
28+
``` bash
29+
bundle exec jekyll serve
30+
```
31+
32+
It will show output like this, and you can grab the Server address
33+
and open it in your browser.
34+
35+
```md
36+
Configuration file: /site/_config.yml
37+
Source: /site
38+
Destination: /site/_site
39+
Incremental build: disabled. Enable with --incremental
40+
Generating...
41+
done in 3.609 seconds.
42+
Auto-regeneration: enabled for '/site'
43+
Server address: http://0.0.0.0:4000
44+
```
45+
46+
## Adding New Entries to the Registries
47+
48+
To add a new entry to the registries (either an OpenAPI
49+
Specification Extension namespace or a specific OpenAPI
50+
Specification Extension),
51+
fork this repository in GitHub.
52+
Make a local clone of your fork and check out the
53+
`gh-pages` branch.
54+
55+
### Add a New Extension Namespace Registry Entry
56+
57+
Working in the `gh-pages` branch,
58+
add a new Markdown file in `registries/_namespace/`. The file name
59+
should be the namespace name with a `.md` extension, without the `x-`
60+
prefix.
61+
For example, to add an extension namespace `abc` for extensions named `x-abc-*`,
62+
create `registries/_namespace/abc.md`. Use the following template,
63+
replacing the instruction text in `<<instruction-text>>` markers:
64+
65+
```md
66+
---
67+
owner: <<Your-GutHub-username>>
68+
issue:
69+
description: <<Briefly describe your namespace>>
70+
layout: default
71+
---
72+
73+
{% capture summary %}
74+
The `x-{{page.slug}}-` prefix is reserved for extensions created by
75+
<<describe your organization and namespace>>
76+
{% endcapture %}
77+
78+
{% include namespace-entry.md summary=summary %}
79+
80+
```
81+
82+
You may use [GitHub Flavored Markdown](https://github.github.com/gfm/)
83+
in the short and long descriptions.
84+
85+
See [oai.md](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/refs/heads/gh-pages/registries/_namespace/oai.md)
86+
for an example for the `x-oai-*` namespace.
87+
88+
Next, locally build
89+
the site as described above and view
90+
[http://127.0.0.1:4000/registry/namespace/index.html](http://127.0.0.1:4000/registry/namespace/index.html)
91+
to verify your namespace is listed.
92+
(Modify the URL if Jekyll is running on a different IP or port.)
93+
The namespace name in __Value__ column
94+
should link to your namespace page, and the __Description__
95+
text should be the `description:` from the Markdown frontmatter.
96+
97+
Preview your content at
98+
`http://127.0.0.1:4000/registry/namespace/abc.html`
99+
(change `abc` to your namespace name in the URL).
100+
101+
### Add a New Specification Extension Registry Entry
102+
103+
add a new Markdown file in `registries/_extension/`.
104+
The file name should be your specification extension name with
105+
a `.md` file extension, such as
106+
`registries/_extension/x-abc-wander.md` to document the
107+
`x-abc-wander` extension.
108+
109+
Use this template for your file,
110+
replacing the instruction text in `<<instruction-text>>` markers:
111+
112+
```md
113+
---
114+
owner: <<Your-GutHub-username>>
115+
issue:
116+
description: <<Brief description of your Specification Extension>>.
117+
schema:
118+
<<JSON Schema, in YAML format, for validating specification extension instances>>
119+
objects: <<Array of OAS objects where the specification may be used.>>
120+
layout: default
121+
---
122+
123+
{% capture summary %}
124+
<<Detailed description of the extension.>>
125+
126+
Used by: (informational)
127+
128+
* <<bullet list of representative users of the extension>>>
129+
{% endcapture %}
130+
131+
{% capture example %}
132+
133+
<<YAML snippet of OpenAPI source code example showing use of your specification example>
134+
135+
{% endcapture %}
136+
137+
{% include extension-entry.md summary=summary example=example %}
138+
```
139+
140+
You may use [GitHub Flavored Markdown](https://github.github.com/gfm/)
141+
in the short and long descriptions.
142+
143+
See [x-twitter.md](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/refs/heads/gh-pages/registries/_extension/x-twitter.md)
144+
for an example.
145+
146+
Build the site locally as described above.
147+
148+
Preview [http://127.0.0.1:4000/registry/extension/](http://127.0.0.1:4000/registry/extension/).
149+
150+
(Modify the URL if Jekyll is running on a different IP or port.)
151+
Verify that your specification extension
152+
is listed. The __Value__ column should contain your extension name
153+
with a link to your documentation, such as
154+
`http://127.0.0.1:4000/registry/extension/x-abc-wander.html`,
155+
and the __Description__ should be your brief description.
156+
157+
### Submitting
158+
159+
When you have verified your content renders correctly,
160+
submit a Pull Request against the `gh-pages` branch
161+
of `git@github.com:OAI/OpenAPI-Specification.git`.
162+
Committers will review the PR and you may be asked
163+
to update the PR. When approved, committers
164+
will merge your PR into `git@github.com:OAI/OpenAPI-Specification.git`
165+
and the merge actions will publish your changes to
166+
[https://spec.openapis.org/registry/](https://spec.openapis.org/registry/).

‎renderings/oas/site/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎renderings/oas/site/Makefile‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
all:
2+
npm run build-src
3+
npm test
4+

0 commit comments

Comments
 (0)