Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .redocly.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,22 @@
apis:
admin:
root: "./docs/api/admin.yaml"
decorators:
remove-x-internal: on
admin-internal:
root: "./docs/api/admin.yaml"
public:
root: "./docs/api/public.yaml"
decorators:
remove-x-internal: on
public-internal:
root: "./docs/api/public.yaml"
metric:
root: "./docs/api/metric.yaml"
decorators:
remove-x-internal: on
metric-internal:
root: "./docs/api/public.yaml"

extends:
- minimal
Expand Down
9 changes: 6 additions & 3 deletions docs/api/components/parameters.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,13 +65,16 @@ keyspace:
schema:
type: string
examples:
Default scope and collection:
default:
summary: Default scope and collection
value: db1
description: Default scope and collection
Named collection within the default scope:
namedInDefault:
summary: Named collection within the default scope
value: db1.collection1
description: Named collection within the default scope
Fully-qualified scope and collection:
fullyQualified:
summary: Fully-qualified scope and collection
value: db1.scope1.collection1
description: Fully-qualified scope and collection
description: |-
Expand Down
3 changes: 2 additions & 1 deletion docs/api/paths/admin/keyspace-_bulk_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ post:
rev: 6-b3e8dcf825b71ccee112f3572ec4323c
- id: BobSettings
rev: 2-5145e1086bb8d1d71a531e9f6b543c58
Partial success:
PartialSuccess:
summary: PartialSuccess
value:
- error: conflict
id: FooBar
Expand Down
12 changes: 8 additions & 4 deletions docs/api/paths/admin/keyspace-_purge.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,13 @@ post:
enum:
- '*'
examples:
Example:
single:
summary: 'Single document'
value:
doc_id:
- '*'
Multiple purges example:
multiple:
summary: 'Multiple documents'
value:
doc_id_1:
- '*'
Expand All @@ -70,12 +72,14 @@ post:
required:
- purged
examples:
Example:
single:
summary: 'Single document'
value:
purged:
doc_id:
- '*'
Multiple purges example:
multiple:
summary: 'Multiple documents'
value:
purged:
doc_id_1:
Expand Down
3 changes: 2 additions & 1 deletion docs/api/paths/public/keyspace-_bulk_docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,8 @@ post:
rev: 6-b3e8dcf825b71ccee112f3572ec4323c
- id: BobSettings
rev: 2-5145e1086bb8d1d71a531e9f6b543c58
Partial success:
PartialSuccess:
summary: "Partial success"
value:
- error: conflict
id: FooBar
Expand Down