Skip to content

Commit 20abca8

Browse files
committed
build: deploy docs
1 parent 99c3451 commit 20abca8

File tree

2 files changed

+12
-95
lines changed

2 files changed

+12
-95
lines changed

docs/_data/readme.yaml

Lines changed: 6 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -3342,6 +3342,7 @@ quen2404/openapi-diff: >
33423342

33433343

33443344

3345+
33453346

33463347

33473348

@@ -3597,95 +3598,11 @@ Mermade/openapi-filter: >
35973598
"status": "403"
35983599
}
35993600
Mermade/openapi-extract: >
3600-
# openapi-extract
3601-
3602-
3603-
![ci](https://github.com/Mermade/openapi-extract/workflows/ci/badge.svg)
3604-
3605-
3606-
Extract paths, operations, parameters, schemas etc from OpenAPI/Swagger definitions.
3607-
3608-
3609-
Works with OpenAPI/Swagger 2.0 and 3.x definitions.
3610-
3611-
3612-
```
3613-
3614-
Usage: openapi-extract [options] {infile} [{outfile}]
3615-
3616-
3617-
Options:
3618-
-h, --help Show help [boolean]
3619-
--version Show version number [boolean]
3620-
--openai make the definition OpenAI compliant [boolean]
3621-
--server include server information [boolean]
3622-
--shard shard the input to an output directory [string]
3623-
-p, --path the path to extract [string]
3624-
-o, --operationid the operationIds to extract [array]
3625-
-m, --method the method to extract for the given path [string]
3626-
-i, --info copy full info object, otherwise minimal [boolean]
3627-
-d, --removeDocs remove all externalDocs properties [boolean]
3628-
-r, --removeExamples remove all example/examples properties [boolean]
3629-
-x, --removeExtensions remove all x- extension properties [boolean]
3630-
-s, --security include security information [boolean]
3631-
-v, --verbose increase verbosity [boolean]
3632-
```
3633-
3634-
3635-
or
3636-
3637-
3638-
```javascript
3639-
3640-
const openapiExtractor = require('openapi-extract');
3641-
3642-
const options = {};
3643-
3644-
// options.path = '...';
3645-
3646-
// options.method = '...';
3647-
3648-
// options.operationid = ['...'];
3649-
3650-
const res = openapiExtractor.extract(obj, options);
3651-
3652-
3653-
const map = openapiExtractor.shard(obj, options);
3654-
3655-
```
3656-
3657-
3658-
The `options` object takes the same values as the CLI, for these keys and default values:
3659-
3660-
3661-
* path = ''
3662-
3663-
* method = ''
3664-
3665-
* info = false
3666-
3667-
* openai = false
3668-
3669-
* removeDocs = false
3670-
3671-
* removeExamples = false
3672-
3673-
* removeExtensions = false
3674-
3675-
* server = false
3676-
3677-
* security = false
3678-
3679-
* operationid = []
3680-
3681-
3682-
## OpenAI compliant mode
3683-
3684-
3685-
This option turns on the following rules:
3686-
3687-
3688-
1. The `description` properties must have a maximum length of 300 characters
3601+
{
3602+
"message": "Rate limit exceeded",
3603+
"documentation_url": "https://docs.github.com/en/rest/using-the-rest-api/getting-started-with-the-rest-api#rate-limiting",
3604+
"status": "403"
3605+
}
36893606
webonix/swagger-docs-cfml: >
36903607
{
36913608
"message": "Rate limit exceeded",

docs/_data/tools.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -262,9 +262,9 @@
262262
language: JavaScript
263263
category: "?"
264264
archived: false
265-
stars: 1168
265+
stars: 1169
266266
watch: 19
267-
updated: 2025-11-10T12:48:44Z
267+
updated: 2025-11-13T07:12:07Z
268268
issues: 59
269269
forks: 166
270270
license: MIT
@@ -284,7 +284,7 @@
284284
stars: 687
285285
watch: 32
286286
forks: 61
287-
updated: 2025-11-12T00:01:01Z
287+
updated: 2025-11-13T00:02:43Z
288288
issues: 12
289289
license: BSD-3-Clause
290290
owner: APIs-guru
@@ -316,10 +316,10 @@
316316
OpenAPI 2.0/3.x format
317317
language: Unknown
318318
archived: false
319-
stars: 4278
319+
stars: 4279
320320
watch: 110
321321
forks: 643
322-
updated: 2025-11-12T07:40:41Z
322+
updated: 2025-11-13T23:13:40Z
323323
issues: 302
324324
owner: APIs-guru
325325
logo: https://avatars.githubusercontent.com/u/10975548?v=4
@@ -378,7 +378,7 @@
378378
watch: 968
379379
updated: 2025-11-09T02:52:58Z
380380
issues: 159
381-
forks: 740
381+
forks: 741
382382
license: MIT
383383
owner: Azure
384384
logo: https://avatars.githubusercontent.com/u/6844498?v=4

0 commit comments

Comments
 (0)