-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathredocly.yaml
More file actions
60 lines (60 loc) · 2.14 KB
/
Copy pathredocly.yaml
File metadata and controls
60 lines (60 loc) · 2.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Filters the synced REST API spec (spec/openapi.yml) down to the endpoint
# tags each SDK exposes; everything else (admin, access-tokens, api-keys,
# untagged endpoints like /health) is dropped. The SDK generate pipelines run
# `redocly bundle <api> -o spec/openapi_generated.<api>.yml` before invoking
# their client generators. The js-sdk list additionally keeps `auth` because
# the CLI reaches /teams through the js-sdk's generated schema.
#
# filter-out drops any node (operation or component schema) the upstream
# specs mark `x-not-implemented: true`. It has no applyTo on purpose: the
# flag must work on schemas as well as operations. A kept operation that
# still references a dropped schema loses that media-type entry rather
# than keeping a dangling $ref.
#
# The envd and volume apis filter the synced envd and volume-content specs
# (spec/envd/envd.yaml, spec/openapi-volumecontent.yml) the same way:
# operations the upstream specs mark `x-internal: true` belong to the
# orchestrator's control plane, not to SDKs, so they are dropped before the
# SDK schemas are generated. remove-unused-components then drops the
# component schemas only those operations referenced.
apis:
js-sdk:
root: spec/openapi.yml
decorators:
filter-in:
property: tags
value: [sandboxes, snapshots, templates, tags, auth]
matchStrategy: any
applyTo: Operation
filter-out:
property: x-not-implemented
value: [true]
python-sdk:
root: spec/openapi.yml
decorators:
filter-in:
property: tags
value: [sandboxes, snapshots, templates, tags]
matchStrategy: any
applyTo: Operation
filter-out:
property: x-not-implemented
value: [true]
go-sdk:
root: spec/openapi.yml
decorators:
filter-in:
property: tags
value: [sandboxes, snapshots, templates, tags]
matchStrategy: any
applyTo: Operation
filter-out:
property: x-not-implemented
value: [true]
envd:
root: spec/envd/envd.yaml
decorators:
filter-out:
property: x-internal
value: [true]
remove-unused-components: on