Skip to content

Commit 124b90e

Browse files
torcolvinbbrks
authored andcommitted
Add new targets for generating internal apis (#6699)
* Add new targets for generating internal apis * Address lint issues with newest redocly api
1 parent 0380e11 commit 124b90e

File tree

5 files changed

+30
-9
lines changed

5 files changed

+30
-9
lines changed

.redocly.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,22 @@
1111
apis:
1212
admin:
1313
root: "./docs/api/admin.yaml"
14+
decorators:
15+
remove-x-internal: on
16+
admin-internal:
17+
root: "./docs/api/admin.yaml"
1418
public:
1519
root: "./docs/api/public.yaml"
20+
decorators:
21+
remove-x-internal: on
22+
public-internal:
23+
root: "./docs/api/public.yaml"
1624
metric:
1725
root: "./docs/api/metric.yaml"
26+
decorators:
27+
remove-x-internal: on
28+
metric-internal:
29+
root: "./docs/api/public.yaml"
1830

1931
extends:
2032
- minimal

docs/api/components/parameters.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,13 +65,16 @@ keyspace:
6565
schema:
6666
type: string
6767
examples:
68-
Default scope and collection:
68+
default:
69+
summary: Default scope and collection
6970
value: db1
7071
description: Default scope and collection
71-
Named collection within the default scope:
72+
namedInDefault:
73+
summary: Named collection within the default scope
7274
value: db1.collection1
7375
description: Named collection within the default scope
74-
Fully-qualified scope and collection:
76+
fullyQualified:
77+
summary: Fully-qualified scope and collection
7578
value: db1.scope1.collection1
7679
description: Fully-qualified scope and collection
7780
description: |-

docs/api/paths/admin/keyspace-_bulk_docs.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,8 @@ post:
8888
rev: 6-b3e8dcf825b71ccee112f3572ec4323c
8989
- id: BobSettings
9090
rev: 2-5145e1086bb8d1d71a531e9f6b543c58
91-
Partial success:
91+
PartialSuccess:
92+
summary: PartialSuccess
9293
value:
9394
- error: conflict
9495
id: FooBar

docs/api/paths/admin/keyspace-_purge.yaml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ post:
4141
enum:
4242
- '*'
4343
examples:
44-
Example:
44+
single:
45+
summary: 'Single document'
4546
value:
4647
doc_id:
4748
- '*'
48-
Multiple purges example:
49+
multiple:
50+
summary: 'Multiple documents'
4951
value:
5052
doc_id_1:
5153
- '*'
@@ -70,12 +72,14 @@ post:
7072
required:
7173
- purged
7274
examples:
73-
Example:
75+
single:
76+
summary: 'Single document'
7477
value:
7578
purged:
7679
doc_id:
7780
- '*'
78-
Multiple purges example:
81+
multiple:
82+
summary: 'Multiple documents'
7983
value:
8084
purged:
8185
doc_id_1:

docs/api/paths/public/keyspace-_bulk_docs.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,8 @@ post:
8484
rev: 6-b3e8dcf825b71ccee112f3572ec4323c
8585
- id: BobSettings
8686
rev: 2-5145e1086bb8d1d71a531e9f6b543c58
87-
Partial success:
87+
PartialSuccess:
88+
summary: "Partial success"
8889
value:
8990
- error: conflict
9091
id: FooBar

0 commit comments

Comments
 (0)