Skip to content

Commit

Permalink
Backport rest API tweaks for docs (#6182) to release/3.1.0 (#6248)
Browse files Browse the repository at this point in the history
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
  • Loading branch information
torcolvin and osfameron authored May 16, 2023
1 parent 341f20f commit 01e4989
Show file tree
Hide file tree
Showing 106 changed files with 195 additions and 110 deletions.
1 change: 0 additions & 1 deletion .redocly.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ lint:
rules:
# disable unnecessary/invalid warnings
operation-2xx-response: off # _blipsync 101 Upgrade ...
operation-operationId: off # Optional (mostly used for generating code)
operation-summary: off # Optional field
no-ambiguous-paths: off # /{db}/{doc} != /_debug/expvar
no-identical-paths: off # /{db} != /{targetdb}
Expand Down
3 changes: 2 additions & 1 deletion docs/api/paths/admin/-.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get server information
description: Returns information about the Sync Gateway node.
Expand All @@ -18,6 +17,7 @@ get:
$ref: ../../components/schemas.yaml#/NodeInfo
tags:
- Server
operationId: get_-
head:
responses:
'200':
Expand All @@ -26,3 +26,4 @@ head:
- Server
summary: Check if server online
description: Check if the server is online by checking the status code of response.
operationId: head_-
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_all_dbs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get a list of all the databases
description: |-
Expand All @@ -25,6 +24,7 @@ get:
type: string
tags:
- Database Management
operationId: get__all_dbs
head:
summary: /_all_dbs
description: |-
Expand All @@ -36,3 +36,4 @@ head:
description: OK
tags:
- Database Management
operationId: head__all_dbs
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get server configuration
description: |-
Expand Down Expand Up @@ -33,6 +32,7 @@ get:
$ref: ../../components/responses.yaml#/request-problem
tags:
- Server
operationId: get__config
put:
summary: Set runtime configuration
description: |-
Expand All @@ -57,3 +57,4 @@ put:
$ref: ../../components/responses.yaml#/request-problem
tags:
- Server
operationId: put__config
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-fgprof.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get fgprof profile
description: |-
Expand All @@ -25,6 +24,7 @@ get:
type: string
tags:
- Profiling
operationId: get__debug-fgprof
post:
summary: Get fgprof profile
description: |-
Expand All @@ -44,3 +44,4 @@ post:
type: string
tags:
- Profiling
operationId: post__debug-fgprof
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-block.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get block profile
description: |-
Expand All @@ -30,6 +29,7 @@ get:
reason: Can only run one mutex profile at a time
tags:
- Profiling
operationId: get__debug-pprof-block
post:
summary: Get block profile
description: |-
Expand All @@ -54,3 +54,4 @@ post:
reason: Can only run one mutex profile at a time
tags:
- Profiling
operationId: post__debug-pprof-block
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-cmdline.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get passed in command line parameters
description: |-
Expand All @@ -23,6 +22,7 @@ get:
type: string
tags:
- Profiling
operationId: get__debug-pprof-cmdline
post:
summary: Get passed in command line parameters
description: |-
Expand All @@ -40,3 +40,4 @@ post:
type: string
tags:
- Profiling
operationId: post__debug-pprof-cmdline
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-goroutine.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get goroutine profile
description: |-
Expand All @@ -21,6 +20,7 @@ get:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: get__debug-pprof-goroutine
post:
summary: Get goroutine profile
description: |-
Expand All @@ -36,3 +36,4 @@ post:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: post__debug-pprof-goroutine
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-heap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get the heap pprof debug file
description: |-
Expand All @@ -19,6 +18,7 @@ get:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: get__debug-pprof-heap
post:
summary: Get the heap pprof debug file
description: |-
Expand All @@ -32,3 +32,4 @@ post:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: post__debug-pprof-heap
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-mutex.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get mutex profile
description: |-
Expand All @@ -30,6 +29,7 @@ get:
reason: Can only run one mutex profile at a time
tags:
- Profiling
operationId: get__debug-pprof-mutex
post:
summary: Get mutex profile
description: |-
Expand All @@ -54,3 +54,4 @@ post:
reason: Can only run one mutex profile at a time
tags:
- Profiling
operationId: post__debug-pprof-mutex
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-profile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get the profile pprof debug file
description: |-
Expand All @@ -19,6 +18,7 @@ get:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: get__debug-pprof-profile
post:
summary: Get the profile pprof debug file
description: |-
Expand All @@ -32,3 +32,4 @@ post:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: post__debug-pprof-profile
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-symbol.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get symbol pprof debug information
description: |-
Expand All @@ -21,6 +20,7 @@ get:
type: string
tags:
- Profiling
operationId: get__debug-pprof-symbol
post:
summary: Get symbol pprof debug information
description: |-
Expand All @@ -36,3 +36,4 @@ post:
type: string
tags:
- Profiling
operationId: post__debug-pprof-symbol
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-threadcreate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get the threadcreate pprof debug file
description: |-
Expand All @@ -17,6 +16,7 @@ get:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: get__debug-pprof-threadcreate
post:
summary: Get the threadcreate pprof debug file
description: |-
Expand All @@ -28,3 +28,4 @@ post:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: post__debug-pprof-threadcreate
3 changes: 2 additions & 1 deletion docs/api/paths/admin/_debug-pprof-trace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get trace profile
description: |-
Expand All @@ -25,6 +24,7 @@ get:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: get__debug-pprof-trace
post:
summary: Get trace profile
description: |-
Expand All @@ -44,3 +44,4 @@ post:
$ref: ../../components/responses.yaml#/pprof-binary
tags:
- Profiling
operationId: post__debug-pprof-trace
2 changes: 1 addition & 1 deletion docs/api/paths/admin/_expvar.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get all Sync Gateway statistics
description: |-
Expand All @@ -27,3 +26,4 @@ get:
$ref: ../../components/schemas.yaml#/ExpVars
tags:
- Metrics
operationId: get__expvar
2 changes: 1 addition & 1 deletion docs/api/paths/admin/_heap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

post:
summary: Dump heap profile
description: |-
Expand All @@ -23,3 +22,4 @@ post:
$ref: ../../components/responses.yaml#/request-problem
tags:
- Profiling
operationId: post__heap
4 changes: 3 additions & 1 deletion docs/api/paths/admin/_logging.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

get:
summary: Get console logging settings
description: |-
Expand All @@ -25,6 +24,7 @@ get:
deprecated: true
tags:
- Server
operationId: get__logging
put:
summary: Set console logging settings
description: |-
Expand All @@ -51,6 +51,7 @@ put:
deprecated: true
tags:
- Server
operationId: put__logging
post:
summary: Update console logging settings
description: |-
Expand All @@ -77,3 +78,4 @@ post:
deprecated: true
tags:
- Server
operationId: post__logging
2 changes: 1 addition & 1 deletion docs/api/paths/admin/_post_upgrade.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

post:
summary: Run the post upgrade process on all databases
description: |-
Expand Down Expand Up @@ -57,3 +56,4 @@ post:
- post_upgrade_results
tags:
- Server
operationId: post__post_upgrade
2 changes: 1 addition & 1 deletion docs/api/paths/admin/_profile-profilename.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

parameters:
- name: profilename
in: path
Expand Down Expand Up @@ -38,3 +37,4 @@ post:
$ref: ../../components/responses.yaml#/Not-found
tags:
- Profiling
operationId: post__profile-profilename
2 changes: 1 addition & 1 deletion docs/api/paths/admin/_profile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

post:
summary: Start or Stop continuous CPU profiling
description: |-
Expand All @@ -27,3 +26,4 @@ post:
$ref: ../../components/responses.yaml#/request-problem
tags:
- Profiling
operationId: post__profile
Loading

0 comments on commit 01e4989

Please sign in to comment.