Skip to content

Commit 4c1c273

Browse files
SnakeDocSnakeDoc
authored
docs: improve docs (#8)
1 parent 5c67ba9 commit 4c1c273

File tree

6 files changed

+322
-33
lines changed

6 files changed

+322
-33
lines changed

‎.markdownlint-cli2.jsonc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
}
77
},
88
"globs": ["**/*.md"],
9-
"ignores": ["node_modules"]
9+
"ignores": ["node_modules", "LICENSE"]
1010
}

‎.prettierignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
LICENSE

‎LICENSE‎

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

‎README.md‎

Lines changed: 115 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,141 @@
1-
# Bymbly OpenAPI Tools
1+
# OpenAPI Tools
22

3-
Shared Tooling for OpenAPI Specs
3+
Standardized CLI tooling for OpenAPI specifications.
4+
Provides consistent conventions and environment-based configuration.
45

5-
To use, add this to your local `.npmrc`:
6+
## Installation
7+
8+
1. Configure npm to use Github Packages for `@bymbly` scope:
9+
10+
```bash
11+
# Add to .npmrc in your project or globally (~/.npmrc)
12+
@bymbly:registry=https://npm.pkg.github.com
13+
//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_TOKEN}
14+
```
15+
16+
1. Create a GitHub Personal Access Token (Classic) with `read:packages` scope.
17+
18+
1. Set environment variable:
19+
20+
```bash
21+
export GITHUB_PACKAGES_TOKEN=your_ghp_token_here
22+
```
23+
24+
This replaces normal `npm login` credentials, and allows access to GitHub's package registry.
25+
26+
[Github Packages Authentication Docs](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages)
27+
28+
1. Then install the package:
29+
30+
```bash
31+
npm install -D @bymbly/openapi-tools@latest
32+
```
33+
34+
## Quick Start
35+
36+
Add to your `package.json`:
37+
38+
```json
39+
{
40+
"scripts": {
41+
"bundle": "redocly-bundle",
42+
"lint": "redocly-lint",
43+
"docs": "redocly-build-docs",
44+
"arazzo": "redocly-generate-arazzo",
45+
"validate": "npm run lint && npm run bundle && npm run docs"
46+
}
47+
}
48+
```
49+
50+
Run:
651

752
```bash
8-
@bymbly:registry=https://npm.pkg.github.com
9-
//npm.pkg.github.com/:_authToken=${GITHUB_PACKAGES_TOKEN}
53+
npm run bundle # Bundles openapi/openapi.yaml -> dist/openapi.yaml
54+
npm run lint # Lints openapi/openapi.yaml
55+
npm run docs # Generates dist/openapi.html
56+
npm run arazzo # Generates dist/auto-generated.arazzo.yaml
1057
```
1158

12-
Create a GitHub PAT (classic) with a scope of: `read:packages`
59+
## Available Commands
60+
61+
### Redocly Commands
62+
63+
<!-- markdownlint-disable MD013 -->
64+
65+
| Command | Description | Default Input | Default Output |
66+
| ------------------------- | ---------------------------------------- | ---------------------- | --------------------------------- |
67+
| `redocly-bundle` | Bundle OpenAPI specs with $refs resolved | `openapi/openapi.yaml` | `dist/openapi.yaml` |
68+
| `redocly-lint` | Lint OpenAPI specs | `openapi/openapi.yaml` | terminal output |
69+
| `redocly-build-docs` | Generate HTML documentation | `openapi/openapi.yaml` | `dist/openapi.html` |
70+
| `redocly-generate-arazzo` | Generate Arazzo workflow descriptions | `openapi/openapi.yaml` | `dist/auto-generated.arazzo.yaml` |
71+
72+
<!-- markdownlint-enable MD013 -->
1373

14-
Set the environment variable: `GITHUB_PACKAGES_TOKEN` to your PAT.
15-
This replaces normal `npm login` creds, and allows access to GitHub's package registry.
74+
## Configuration
75+
76+
All commands use environment variables with sensible defaults:
77+
78+
### `OPENAPI_INPUT`
79+
80+
Path to your OpenAPI specification file.
81+
82+
**Default:** `openapi/openapi.yaml`
1683

17-
Then install the package:
84+
**Example:**
1885

1986
```bash
20-
npm install -D @bymbly/openapi-tools@latest
87+
OPENAPI_INPUT=api/spec.yaml redocly-bundle
2188
```
2289

23-
Now you can add tooling to your local `package.json`:
90+
### `OPENAPI_OUTPUT`
2491

25-
```json
26-
"scripts": {
27-
"bundle": "openapi-bundle",
28-
"lint": "openapi-lint"
29-
}
92+
Where to write output files.
93+
94+
**Defaults:**
95+
96+
- `redocly-bundle`: `dist/openapi.yaml` (extension added based on format)
97+
- `redocly-build-docs`: `./dist/openapi.html`
98+
- `redocly-generate-arazzo`: `dist/auto-generated.arazzo.yaml`
99+
100+
**Example:**
101+
102+
```bash
103+
OPENAPI_OUTPUT=public/api.html redocly-build-docs
30104
```
31105

32-
See:
106+
### `OPENAPI_FORMAT`
33107

34-
- [Authenticating to GitHub Packages](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#authenticating-to-github-packages)
35-
- [Publishing packages to GitHub Packages](https://docs.github.com/en/actions/how-tos/use-cases-and-examples/publishing-packages/publishing-nodejs-packages)
108+
Output or report format.
36109

37-
## Configuration
110+
**Defaults:**
111+
112+
- `redocly-bundle`: `yaml` (options `yaml`, `json`)
113+
- `redocly-lint`: `codeframe` (options: `codeframe`, `stylish`, `json`,
114+
`checkstyle`, `codeclimate`, `github-actions`, `markdown`, `summary`)
115+
116+
**Example:**
38117

39-
Configure via the following environment variables:
118+
```bash
119+
OPENAPI_FORMAT=json redocly-bundle
120+
OPENAPI_FORMAT=github-actions redocly-lint
121+
```
122+
123+
### `OPENAPI_CONFIG`
40124

41-
`OPENAPI_INPUT` - File to process
125+
Path to Redocly configuration file.
42126

43-
- **default** `redocly-*` - `./openapi/openapi.yaml`
127+
**Default:** Auto-discovered (`redocly.yaml` in project root) or Redocly defaults
44128

45-
`OPENAPI_OUTPUT` - Where to write output file
129+
**Example:**
46130

47-
- **default** `redocly-bundle` - `./dist/openapi.yaml`
48-
- **default** `redocly-build-docs` - `./dist/openapi.html`
131+
```bash
132+
OPENAPI_CONFIG=.config/redocly.yaml redocly-lint
133+
```
49134

50-
`OPENAPI_FORMAT` - Output format
135+
## Contributing
51136

52-
- **default** `redocly-bundle` - `yaml`
53-
- **default** `redocly-lint` - `codeframe`
137+
Issues and pull requests welcome!
54138

55-
`OPENAPI_CONFIG_PATH` - Path to redocly.yaml
139+
## License
56140

57-
- **default** `redocly-*` - `none` or `./redocly.yaml`
141+
[Apache License, Version 2.0](https://github.com/bymbly/openapi-tools/blob/main/LICENSE)

‎package-lock.json‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)