From ab521210bf94eba23ddaa011b1e63f1320f49027 Mon Sep 17 00:00:00 2001 From: Hakim Date: Thu, 22 Feb 2024 15:42:54 +0000 Subject: [PATCH] Update config for Redocly from sync_gateway source (#782) * Update config for Redocly from sync_gateway source This will update x-internal settings. via https://github.com/couchbase/docs-sync-gateway/pull/781 and discussion with @torcolvin * Update from release/3.1.3 --- .../assets/attachments/bundled-admin.yaml | 327 +++---- .../assets/attachments/bundled-metric.yaml | 46 +- .../assets/attachments/bundled-public.yaml | 64 +- .../admin/.openapi-generator/VERSION | 2 +- .../_partials/static_restapi/admin/index.adoc | 811 +++++++++++++----- .../_partials/static_restapi/generate.sh | 6 +- .../metric/.openapi-generator/VERSION | 2 +- .../static_restapi/metric/index.adoc | 491 ++++++++++- .../public/.openapi-generator/VERSION | 2 +- .../static_restapi/public/index.adoc | 282 +++++- 10 files changed, 1588 insertions(+), 445 deletions(-) diff --git a/modules/ROOT/assets/attachments/bundled-admin.yaml b/modules/ROOT/assets/attachments/bundled-admin.yaml index bbf73cc3..77d55d46 100644 --- a/modules/ROOT/assets/attachments/bundled-admin.yaml +++ b/modules/ROOT/assets/attachments/bundled-admin.yaml @@ -19,6 +19,34 @@ servers: hostname: description: The hostname to use default: localhost +tags: + - name: Authentication + description: Manage authentication + - name: Server + description: Manage server activities + - name: Database Management + description: Create and manage Sync Gateway databases + - name: Database Configuration + description: Configure Sync Gateway databases + - name: Database Security + description: Create and manage database users and roles + - name: Session + description: Manage user sessions + - name: OpenID Connect + description: Manage OpenID Connect + - name: Document + description: Create and manage documents and attachments + - name: Replication + description: Create and manage inter-Sync Gateway replications + - name: Metrics + description: Get Sync Gateway statistics + - name: Profiling + description: Generate information to help debug and fine-tune Sync Gateway + - name: Unsupported + description: Endpoints that are not supported by Sync Gateway +externalDocs: + description: Sync Gateway Quickstart | Couchbase Docs + url: https://docs.couchbase.com/sync-gateway/current/index.html paths: /{db}/_session: parameters: @@ -655,7 +683,7 @@ paths: responses: '200': description: Properties associated with a user - content: &ref_128 + content: &ref_129 application/json: schema: description: Properties associated with a user @@ -951,7 +979,7 @@ paths: responses: '200': description: Properties associated with a role - content: &ref_129 + content: &ref_130 application/json: schema: description: Properties associated with a role @@ -2219,7 +2247,7 @@ paths: application/json: schema: type: object - properties: &ref_111 + properties: &ref_36 bootstrap: description: Configuration settings for interacting with Couchbase Server. type: object @@ -2400,7 +2428,7 @@ paths: readOnly: true console: type: object - properties: &ref_36 + properties: &ref_110 log_level: description: Log Level for the console output type: string @@ -2511,9 +2539,6 @@ paths: type: integer maximum: 9 minimum: 0 - max_concurrent_replications: - description: Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - type: integer readOnly: true unsupported: description: Settings that are not officially supported. It is highly recommended these are **not** used. @@ -2522,7 +2547,7 @@ paths: serverless: description: Configuration for when SG is running in serverless mode type: object - properties: &ref_110 + properties: &ref_111 enabled: description: Run SG in to serverless mode type: boolean @@ -2620,58 +2645,8 @@ paths: application/json: schema: type: object - properties: &ref_112 - logging: - description: The configuration settings for modifying Sync Gateway logging. - type: object - properties: - log_file_path: - description: Absolute or relative path on the filesystem to the log file directory. A relative path is from the directory that contains the Sync Gateway executable file. - type: string - readOnly: true - redaction_level: - description: Redaction level to apply to log output. - type: string - default: partial - enum: - - none - - partial - - full - - unset - readOnly: true - console: - type: object - properties: *ref_36 - title: Console-logging-config - error: - type: object - properties: *ref_34 - title: File-logging-config - warn: - type: object - properties: *ref_34 - title: File-logging-config - info: - type: object - properties: *ref_34 - title: File-logging-config - debug: - type: object - properties: *ref_34 - title: File-logging-config - trace: - type: object - properties: *ref_34 - title: File-logging-config - stats: - type: object - properties: *ref_34 - title: File-logging-config - max_concurrent_replications: - description: Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - type: integer - default: 0 - title: Runtime-config + properties: *ref_36 + title: Startup-config responses: '200': description: Successfully set runtime options @@ -2697,7 +2672,7 @@ paths: application/json: schema: type: object - properties: &ref_113 + properties: &ref_112 databases: description: Contains a map of all the databases in the node along with their status. type: object @@ -2718,6 +2693,9 @@ paths: enum: - Online - Offline + - Starting + - Stopping + - Resyncing replication_status: type: array items: @@ -3489,7 +3467,7 @@ paths: x-additionalPropertiesName: scopename description: Scope-specific configuration. type: object - properties: &ref_115 + properties: &ref_114 collections: description: An object keyed by collection name containing config for the specific collection. type: object @@ -3497,7 +3475,7 @@ paths: x-additionalPropertiesName: collectionname description: Collection-specific configuration. type: object - properties: &ref_114 + properties: &ref_113 sync: description: The Javascript function that newly created documents in this collection are ran through. type: string @@ -3679,7 +3657,7 @@ paths: enable_star_channel: description: Used to control whether Sync Gateway should use the all documents (*) channel. type: boolean - default: true + default: false max_length: description: The maximum number of entries to maintain in the cache per channel. type: integer @@ -4167,6 +4145,34 @@ paths: type: array items: type: string + logging: + description: Per-database logging configuration. + type: object + properties: + console: + description: Console logging configuration. + type: object + properties: + log_level: + description: Log Level for the console output + type: string + enum: + - none + - error + - warn + - info + - debug + - trace + example: debug + log_keys: + description: Log Keys for the console output + type: array + items: + type: string + example: + - CRUD + - HTTP + - Query title: Database-config '404': description: Resource could not be found @@ -4634,6 +4640,12 @@ paths: description: '**Use this only when requested to do so by the Couchbase support team** This request will regenerate the sequence numbers for each document processed.' schema: type: boolean + - name: reset + in: query + description: This forces a fresh resync run instead of trying to resume the previous resync operation + schema: + type: boolean + default: false requestBody: content: application/json: @@ -4643,10 +4655,10 @@ paths: scopes: description: This controls for which collections resync will run type: object - additionalProperties: &ref_117 + additionalProperties: &ref_116 description: List of collection names type: array - items: &ref_116 + items: &ref_115 type: string regenerate_sequences: description: This can be used as an alternative to query param `regenerate_sequences`. If either query param or this is set to true, then the request will regenerate the sequence numbers for each document processed. @@ -5195,35 +5207,50 @@ paths: get: summary: Get a list of all the databases description: |- - This retrieves all the database's names that are in the current Sync Gateway node. + This retrieves all the databases that are in the current Sync Gateway node. If verbose, returns bucket and state information for each database, otherwise returns names only. Required Sync Gateway RBAC roles: * Sync Gateway Dev Ops + parameters: + - name: verbose + in: query + schema: + type: boolean responses: '200': description: Successfully retrieved all database names content: application/json: schema: - type: array - items: - type: string + oneOf: + - description: The names of all databases. + type: array + items: &ref_117 + type: string + - description: Description of all databases. + type: array + items: &ref_118 + type: object + properties: + db_name: + type: string + description: The name of the database. + bucket: + type: string + description: The Couchbase Server backing bucket for the database. + state: + description: The database state. + type: string + enum: + - Online + - Offline + - Starting + - Stopping + - Resyncing tags: - Database Management operationId: get__all_dbs - head: - summary: /_all_dbs - description: |- - Required Sync Gateway RBAC roles: - - * Sync Gateway Dev Ops - responses: - '200': - description: OK - tags: - - Database Management - operationId: head__all_dbs /{db}/_compact: parameters: - name: db @@ -5331,7 +5358,7 @@ paths: schema: description: The status returned from a compaction. type: object - properties: &ref_118 + properties: &ref_119 status: description: The status of the current operation. type: string @@ -5381,7 +5408,7 @@ paths: - mark - sweep - cleanup - required: &ref_119 + required: &ref_120 - status - start_time - last_error @@ -5762,7 +5789,7 @@ paths: application/javascript: schema: type: object - properties: &ref_120 + properties: &ref_121 cmdline: description: Built-in variables from the Go runtime, lists the command-line arguments type: object @@ -5976,7 +6003,7 @@ paths: application/json: schema: type: object - properties: &ref_121 + properties: &ref_122 ADMIN: description: '`true` if the request is from the Admin API - otherwise omitted.' type: boolean @@ -6013,7 +6040,7 @@ paths: `true` if the sync gateway node is running in persistent config mode. type: boolean example: true - required: &ref_122 + required: &ref_123 - couchdb - vendor tags: @@ -6028,6 +6055,30 @@ paths: summary: Check if server online description: Check if the server is online by checking the status code of response. operationId: head_- + /_ping: + get: + summary: Check if API is available + description: Returns OK status if API is available. + responses: + '200': + description: Returned status + content: + text/plain: + schema: + type: string + example: OK + tags: + - Server + operationId: get__ping + head: + responses: + '200': + description: Server is available + tags: + - Server + summary: Check if API is available + description: Returns OK status if API is available. + operationId: head__ping /{keyspace}/_all_docs: parameters: - name: keyspace @@ -6602,7 +6653,7 @@ paths: schema: description: Properties of a changes feed type: object - properties: &ref_123 + properties: &ref_124 results: type: array items: @@ -7478,7 +7529,7 @@ paths: responses: '200': description: New revision created successfully - content: &ref_130 + content: &ref_131 application/json: schema: description: Properties returned when a new document revision is created @@ -8037,7 +8088,7 @@ paths: application/json: schema: type: object - properties: &ref_124 + properties: &ref_125 id_token: description: The OpenID Connect ID token type: string @@ -8276,12 +8327,12 @@ paths: responses: '200': description: Properties expected back from an OpenID Connect provider after successful authentication - content: &ref_131 + content: &ref_132 application/json: schema: description: Properties expected back from an OpenID Connect provider after successful authentication type: object - properties: &ref_125 + properties: &ref_126 access_token: type: string token_type: @@ -8438,12 +8489,12 @@ paths: schema: *ref_95 description: The OpenID Connect authentication scope. requestBody: - content: &ref_132 + content: &ref_133 application/json: schema: description: Properties passed from the OpenID Connect mock login page to the handler type: object - properties: &ref_126 + properties: &ref_127 username: type: string tokenttl: @@ -8452,7 +8503,7 @@ paths: type: string authenticated: type: string - required: &ref_127 + required: &ref_128 - username - tokenttl - identity-token-formats @@ -8517,34 +8568,6 @@ paths: tags: - Replication operationId: get_db-_blipsync -tags: - - name: Authentication - description: Manage authentication - - name: Server - description: Manage server activities - - name: Database Management - description: Create and manage Sync Gateway databases - - name: Database Configuration - description: Configure Sync Gateway databases - - name: Database Security - description: Create and manage database users and roles - - name: Session - description: Manage user sessions - - name: OpenID Connect - description: Manage OpenID Connect - - name: Document - description: Create and manage documents and attachments - - name: Replication - description: Create and manage inter-Sync Gateway replications - - name: Metrics - description: Get Sync Gateway statistics - - name: Profiling - description: Generate information to help debug and fine-tune Sync Gateway - - name: Unsupported - description: Endpoints that are not supported by Sync Gateway -externalDocs: - description: Sync Gateway Quickstart | Couchbase Docs - url: https://docs.couchbase.com/sync-gateway/current/index.html components: parameters: db: @@ -8996,7 +9019,7 @@ components: title: Log-rotation-config Console-logging-config: type: object - properties: *ref_36 + properties: *ref_110 title: Console-logging-config File-logging-config: type: object @@ -9005,7 +9028,7 @@ components: Serverless: description: Configuration for when SG is running in serverless mode type: object - properties: *ref_110 + properties: *ref_111 CredentialsConfig: description: The configuration for the credentials set. type: object @@ -9013,25 +9036,21 @@ components: title: Credentials config Startup-config: type: object - properties: *ref_111 + properties: *ref_36 title: Startup-config - Runtime-config: - type: object - properties: *ref_112 - title: Runtime-config Status: type: object - properties: *ref_113 + properties: *ref_112 title: Status CollectionConfig: description: Collection-specific configuration. type: object - properties: *ref_114 + properties: *ref_113 title: Collection config Scopes: description: Scope-specific configuration. type: object - properties: *ref_115 + properties: *ref_114 title: Scopes Event-config: type: object @@ -9051,16 +9070,24 @@ components: CollectionNames: description: List of collection names type: array - items: *ref_116 + items: *ref_115 ResyncScopesMap: description: scope name with one or more collection names for which resync will be triggered type: object - additionalProperties: *ref_117 + additionalProperties: *ref_116 + All DBs: + description: The names of all databases. + type: array + items: *ref_117 + All DBs Verbose: + description: Description of all databases. + type: array + items: *ref_118 Compact-status: description: The status returned from a compaction. type: object - properties: *ref_118 - required: *ref_119 + properties: *ref_119 + required: *ref_120 title: Compact-status Document: description: The configurable Sync Gateway properties of a document. @@ -9075,33 +9102,33 @@ components: title: New-revision ExpVars: type: object - properties: *ref_120 + properties: *ref_121 NodeInfo: type: object - properties: *ref_121 - required: *ref_122 + properties: *ref_122 + required: *ref_123 Changes-feed: description: Properties of a changes feed type: object - properties: *ref_123 + properties: *ref_124 Design-doc: description: Properties of a design document type: object properties: *ref_63 OIDC-callback: type: object - properties: *ref_124 + properties: *ref_125 title: OpenID Connect callback properties OIDC-token: description: Properties expected back from an OpenID Connect provider after successful authentication type: object - properties: *ref_125 + properties: *ref_126 title: OIDC-token OIDC-login-page-handler: description: Properties passed from the OpenID Connect mock login page to the handler type: object - properties: *ref_126 - required: *ref_127 + properties: *ref_127 + required: *ref_128 responses: User-session-information: description: Properties associated with a user session @@ -9120,10 +9147,10 @@ components: content: *ref_14 User: description: Properties associated with a user - content: *ref_128 + content: *ref_129 Role: description: Properties associated with a role - content: *ref_129 + content: *ref_130 Replicator-updated: description: Updated existing configuration successfully Replicator-created: @@ -9161,7 +9188,7 @@ components: content: *ref_84 New-revision: description: New revision created successfully - content: *ref_130 + content: *ref_131 OIDC-invalid-provider: description: 'The provider provided is not defined in the Sync Gateway config. If no provided was specified then there is no default provider set. ' OIDC-connection: @@ -9179,7 +9206,7 @@ components: content: *ref_97 OIDC-token: description: Properties expected back from an OpenID Connect provider after successful authentication - content: *ref_131 + content: *ref_132 OIDC-testing-redirect: description: Redirecting to Sync Gateway OpenID Connect callback URL headers: *ref_99 @@ -9196,5 +9223,5 @@ components: Profile: content: *ref_32 OIDC-login-page-handler: - content: *ref_132 + content: *ref_133 description: Properties passed from the OpenID Connect mock login page to the handler diff --git a/modules/ROOT/assets/attachments/bundled-metric.yaml b/modules/ROOT/assets/attachments/bundled-metric.yaml index 601015fb..71474f0b 100644 --- a/modules/ROOT/assets/attachments/bundled-metric.yaml +++ b/modules/ROOT/assets/attachments/bundled-metric.yaml @@ -19,9 +19,39 @@ servers: hostname: description: The hostname to use default: localhost +tags: + - name: Prometheus + description: Endpoints for use with Prometheus +externalDocs: + description: Sync Gateway Quickstart | Couchbase Docs + url: https://docs.couchbase.com/sync-gateway/current/index.html paths: - /_metrics: + /_ping: get: + summary: Check if API is available + description: Returns OK status if API is available. + responses: + '200': + description: Returned status + content: + text/plain: + schema: + type: string + example: OK + tags: + - Server + operationId: get__ping + head: + responses: + '200': + description: Server is available + tags: + - Server + summary: Check if API is available + description: Returns OK status if API is available. + operationId: head__ping + /_metrics: + get: &ref_0 summary: Debugging/monitoring runtime stats in Prometheus Exposition format description: |- Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format. @@ -40,7 +70,9 @@ paths: type: string tags: - Prometheus - operationId: get__metrics + operationId: get_metrics + /metrics: + get: *ref_0 /_expvar: get: summary: Get all Sync Gateway statistics @@ -61,7 +93,7 @@ paths: application/javascript: schema: type: object - properties: &ref_0 + properties: &ref_1 cmdline: description: Built-in variables from the Go runtime, lists the command-line arguments type: object @@ -262,14 +294,8 @@ paths: type: integer deprecated: true operationId: get__expvar -tags: - - name: Prometheus - description: Endpoints for use with Prometheus -externalDocs: - description: Sync Gateway Quickstart | Couchbase Docs - url: https://docs.couchbase.com/sync-gateway/current/index.html components: schemas: ExpVars: type: object - properties: *ref_0 + properties: *ref_1 diff --git a/modules/ROOT/assets/attachments/bundled-public.yaml b/modules/ROOT/assets/attachments/bundled-public.yaml index 8e0f705a..269aa6e0 100644 --- a/modules/ROOT/assets/attachments/bundled-public.yaml +++ b/modules/ROOT/assets/attachments/bundled-public.yaml @@ -19,6 +19,26 @@ servers: hostname: description: The hostname to use default: localhost +tags: + - name: Server + description: Manage server activities + - name: Database Management + description: Create and manage Sync Gateway databases + - name: Session + description: Manage user sessions + - name: Authentication + description: Manage OpenID Connect Authentication + - name: Document + description: Create and manage documents + - name: Document Attachment + description: Create and manage document attachments + - name: Replication + description: Create and manage inter-Sync Gateway replications + - name: Unsupported + description: Endpoints that are not supported by Sync Gateway +externalDocs: + description: Sync Gateway Quickstart | Couchbase Docs + url: https://docs.couchbase.com/sync-gateway/current/index.html paths: /{db}/_session: parameters: @@ -362,6 +382,30 @@ paths: summary: Check if server online description: Check if the server is online by checking the status code of response. operationId: head_- + /_ping: + get: + summary: Check if API is available + description: Returns OK status if API is available. + responses: + '200': + description: Returned status + content: + text/plain: + schema: + type: string + example: OK + tags: + - Server + operationId: get__ping + head: + responses: + '200': + description: Server is available + tags: + - Server + summary: Check if API is available + description: Returns OK status if API is available. + operationId: head__ping /{keyspace}/: parameters: - name: keyspace @@ -2881,26 +2925,6 @@ paths: tags: - Replication operationId: get_db-_blipsync -tags: - - name: Server - description: Manage server activities - - name: Database Management - description: Create and manage Sync Gateway databases - - name: Session - description: Manage user sessions - - name: Authentication - description: Manage OpenID Connect Authentication - - name: Document - description: Create and manage documents - - name: Document Attachment - description: Create and manage document attachments - - name: Replication - description: Create and manage inter-Sync Gateway replications - - name: Unsupported - description: Endpoints that are not supported by Sync Gateway -externalDocs: - description: Sync Gateway Quickstart | Couchbase Docs - url: https://docs.couchbase.com/sync-gateway/current/index.html components: parameters: db: diff --git a/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION b/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION index 4be2c727..8b23b8d4 100644 --- a/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION +++ b/modules/ROOT/pages/_partials/static_restapi/admin/.openapi-generator/VERSION @@ -1 +1 @@ -6.5.0 \ No newline at end of file +7.3.0 \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc b/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc index 16cd2ecc..e1b4176b 100644 --- a/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/admin/index.adoc @@ -5158,7 +5158,6 @@ Create and manage Sync Gateway databases * xref:#+get_db-_compact+[Get the status of the most recent compact operation] * xref:#+get_db-_resync+[Get resync status] * xref:#+get_keyspace-_changes+[Get changes list] -* xref:#+head__all_dbs+[/_all_dbs] * xref:#+head_db-+[Check if database exists] * xref:#+head_keyspace-_changes+[/{db}/_changes] * xref:#+post_db-_compact+[Manage a compact operation] @@ -5386,7 +5385,7 @@ GET /_all_dbs [markdown] -- -This retrieves all the database's names that are in the current Sync Gateway node. +This retrieves all the databases that are in the current Sync Gateway node. If verbose, returns bucket and state information for each database, otherwise returns names only. Required Sync Gateway RBAC roles: @@ -5406,11 +5405,43 @@ Required Sync Gateway RBAC roles: // markup not found, no include::{specDir}paths/get__all_dbs/operation-parameters-before.adoc[opts=optional] +===== Parameters +// tag::get__all_dbs-parameters[] + + +// markup not found, no include::{specDir}paths/get__all_dbs/operation-parameters-begin.adoc[opts=optional] + + + + + + +====== Query Parameters + +[cols="2,3,1"] +|=== +|Name| Description| Schema + +a| +*verbose* + +_optional_ +a| +[markdown] +-- +-- +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +// end + +| Boolean +|=== // markup not found, no include::{specDir}paths/get__all_dbs/operation-parameters-end.adoc[opts=optional] @@ -5446,7 +5477,7 @@ Required Sync Gateway RBAC roles: | 200 a| Successfully retrieved all database names -| List +| xref:#++get__all_dbs_200_response++[+get__all_dbs_200_response+] |=== @@ -6520,143 +6551,6 @@ endif::internal-generation[] -// markup not found, no include::{specDir}paths/head__all_dbs/operation-before.adoc[opts=optional] - - -[#head__all_dbs] -==== /_all_dbs -.... -HEAD /_all_dbs -.... - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-begin.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-before.adoc[opts=optional] - - -[#head__all_dbs-description] -===== Description - -// tag::head__all_dbs-description[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-begin.adoc[opts=optional] - - -[markdown] --- -Required Sync Gateway RBAC roles: - -* Sync Gateway Dev Ops --- - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-end.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-description-after.adoc[opts=optional] - - -// end::head__all_dbs-description[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-parameters-before.adoc[opts=optional] - - - - - - - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-parameters-end.adoc[opts=optional] - -// end::head__all_dbs-parameters[] - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-parameters-after.adoc[opts=optional] - - - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-before.adoc[opts=optional] - - -[#head__all_dbs-responses] -===== Responses - -// tag::head__all_dbs-responses[] - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-begin.adoc[opts=optional] - - -[cols="1,3,1"] -|=== -| HTTP Code | Description | Schema - -| 200 -a| OK -| - - -|=== - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-end.adoc[opts=optional] - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-responses-after.adoc[opts=optional] - -// end::head__all_dbs-responses[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-security-before.adoc[opts=optional] - - - - - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-security-after.adoc[opts=optional] - - -:leveloffset: +4 - -// markup not found, no include::{snippetDir}head__all_dbs/http-request.adoc[opts=optional] - - -// markup not found, no include::{snippetDir}head__all_dbs/http-response.adoc[opts=optional] - -:leveloffset: -4 - - -// file not found, no * wiremock data link :_all_dbs/HEAD/HEAD.json[] - - -ifdef::internal-generation[] -===== Implementation - -// markup not found, no include::{specDir}_all_dbs/HEAD/implementation.adoc[opts=optional] - - -endif::internal-generation[] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-end.adoc[opts=optional] - - -// markup not found, no include::{specDir}paths/head__all_dbs/operation-after.adoc[opts=optional] - - - - // markup not found, no include::{specDir}paths/head_db-/operation-before.adoc[opts=optional] @@ -8053,6 +7947,25 @@ endif::[] | Boolean +a| +*reset* + +_optional_ +a| +[markdown] +-- +This forces a fresh resync run instead of trying to resume the previous resync operation + +-- + +[%hardbreaks] +ifeval::["false" != "null"] +*Default:* `false` +endif::[] +// end + +| Boolean + + |=== @@ -9355,7 +9268,6 @@ Indicates that roles marked as deleted should be included in the result. -- [%hardbreaks] -*Values:* `true`, `false` ifeval::["false" != "null"] *Default:* `false` endif::[] @@ -15525,8 +15437,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -16702,8 +16613,7 @@ ifeval::["{"doc_id":["*"]}" != "null"] endif::[] // end -| List -Map +| xref:#++PostKeyspacePurgeRequest++[+PostKeyspacePurgeRequest+] |=== @@ -16940,8 +16850,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -24843,9 +24752,11 @@ Manage server activities * xref:#+get_-+[Get server information] * xref:#+get__config+[Get server configuration] * xref:#+get__logging+[Get console logging settings] +* xref:#+get__ping+[Check if API is available] * xref:#+get__sgcollect_info+[Get the status of the Sync Gateway Collect Info] * xref:#+get__status+[Get the server status] * xref:#+head_-+[Check if server online] +* xref:#+head__ping+[Check if API is available] * xref:#+post__logging+[Update console logging settings] * xref:#+post__post_upgrade+[Run the post upgrade process on all databases] * xref:#+post__sgcollect_info+[Start Sync Gateway Collect Info] @@ -25483,6 +25394,145 @@ endif::internal-generation[] +// markup not found, no include::{specDir}paths/get__ping/operation-before.adoc[opts=optional] + + +[#get__ping] +==== Check if API is available +.... +GET /_ping +.... + + +// markup not found, no include::{specDir}paths/get__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-before.adoc[opts=optional] + + +[#get__ping-description] +===== Description + +// tag::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-after.adoc[opts=optional] + + +// end::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-end.adoc[opts=optional] + +// end::get__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-after.adoc[opts=optional] + + +[#get__ping-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-before.adoc[opts=optional] + + +[#get__ping-responses] +===== Responses + +// tag::get__ping-responses[] + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Returned status +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-after.adoc[opts=optional] + +// end::get__ping-responses[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}paths/get__sgcollect_info/operation-before.adoc[opts=optional] @@ -25908,6 +25958,141 @@ endif::internal-generation[] +// markup not found, no include::{specDir}paths/head__ping/operation-before.adoc[opts=optional] + + +[#head__ping] +==== Check if API is available +.... +HEAD /_ping +.... + + +// markup not found, no include::{specDir}paths/head__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-before.adoc[opts=optional] + + +[#head__ping-description] +===== Description + +// tag::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-after.adoc[opts=optional] + + +// end::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-end.adoc[opts=optional] + +// end::head__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-after.adoc[opts=optional] + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-before.adoc[opts=optional] + + +[#head__ping-responses] +===== Responses + +// tag::head__ping-responses[] + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Server is available +| + + +|=== + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-after.adoc[opts=optional] + +// end::head__ping-responses[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}head__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}head__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/HEAD/HEAD.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/HEAD/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}paths/post__logging/operation-before.adoc[opts=optional] @@ -26578,7 +26763,7 @@ a| [%hardbreaks] // end -| xref:#++RuntimeConfig++[+RuntimeConfig+] +| xref:#++StartupConfig++[+StartupConfig+] |=== @@ -31218,6 +31403,8 @@ endif::internal-generation[] :desc-Database_config_delta_sync: Delta sync configuration settings. **This is an enterprise-edition feature only** :desc-Database_config_event_handlers: These are the settings for webhooks. :desc-Database_config_local_jwt_value: The providers name. +:desc-Database_config_logging: Per-database logging configuration. +:desc-Database_config_logging_console: Console logging configuration. :desc-Database_config_oidc: Configuration for OpenID Connect authentication. :desc-Database_config_oidc_providers_value: The providers name. :desc-Database_config_roles_value: Properties associated with a role @@ -31292,6 +31479,8 @@ This section describes the properties consumed and returned by this REST API. * xref:#+Database_config_event_handlers+[DatabaseConfigEventHandlers] * xref:#+Database_config_local_jwt_value+[DatabaseConfigLocalJwtValue] * xref:#+Database_config_local_jwt_value_keys_inner+[DatabaseConfigLocalJwtValueKeysInner] +* xref:#+Database_config_logging+[DatabaseConfigLogging] +* xref:#+Database_config_logging_console+[DatabaseConfigLoggingConsole] * xref:#+Database_config_oidc+[DatabaseConfigOidc] * xref:#+Database_config_oidc_providers_value+[DatabaseConfigOidcProvidersValue] * xref:#+Database_config_replications+[DatabaseConfigReplications] @@ -31312,6 +31501,8 @@ This section describes the properties consumed and returned by this REST API. * xref:#+File_logging_config+[File-logging-config] * xref:#+get___200_response+[Get200Response] * xref:#+get___200_response_vendor+[Get200ResponseVendor] +* xref:#+get__all_dbs_200_response+[GetAllDbs200Response] +* xref:#+get__all_dbs_200_response_oneOf_inner+[GetAllDbs200ResponseOneOfInner] * xref:#+get_db__200_response+[GetDb200Response] * xref:#+get_db__200_response_scopes_value+[GetDb200ResponseScopesValue] * xref:#+get_db__200_response_scopes_value_collections_value+[GetDb200ResponseScopesValueCollectionsValue] @@ -31393,7 +31584,6 @@ This section describes the properties consumed and returned by this REST API. * xref:#+Retrieved-replication+[Replication] * xref:#+Role+[Role] * xref:#+Role_1+[Role] -* xref:#+Runtime_config+[Runtime-config] * xref:#+Scopes+[Scopes] * xref:#+Serverless+[Serverless] * xref:#+Startup_config+[Startup-config] @@ -32994,6 +33184,24 @@ endif::[] | xref:#++Database_config_cors++[+Database_config_cors+] +a| *+logging+* + +_optional_ +a| +ifdef::desc-Database_config_logging[] +{desc-Database_config_logging} +endif::[] + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++Database_config_logging++[+Database_config_logging+] + + |=== @@ -33921,6 +34129,24 @@ endif::[] | xref:#++Database_config_cors++[+Database_config_cors+] +a| *+logging+* + +_optional_ +a| +ifdef::desc-Database_config_logging[] +{desc-Database_config_logging} +endif::[] + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++Database_config_logging++[+Database_config_logging+] + + |=== @@ -34233,8 +34459,8 @@ _optional_ a| Used to control whether Sync Gateway should use the all documents (*) channel. [%hardbreaks] -ifeval::["true" != "null"] -*Default:* `true` +ifeval::["false" != "null"] +*Default:* `false` endif::[] ifeval::["null" != "null"] *Example:* `null` @@ -34953,6 +35179,110 @@ endif::[] +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-before.adoc[opts=optional] + + +[#Database_config_logging] +=== DatabaseConfigLogging + + +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-begin.adoc[opts=optional] + + +[#fields-Database_config_logging] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+console+* + +_optional_ +a| +ifdef::desc-Database_config_logging_console[] +{desc-Database_config_logging_console} +endif::[] + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| xref:#++Database_config_logging_console++[+Database_config_logging_console+] + + +|=== + + +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/Database_config_logging/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-before.adoc[opts=optional] + + +[#Database_config_logging_console] +=== DatabaseConfigLoggingConsole + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-begin.adoc[opts=optional] + + +[#fields-Database_config_logging_console] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+log_level+* + +_optional_ +a| Log Level for the console output + +[%hardbreaks] +*Values:* `none`, `error`, `warn`, `info`, `debug`, `trace` +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["debug" != "null"] +*Example:* `debug` +endif::[] +// end +| String + + +a| *+log_keys+* + +_optional_ +a| Log Keys for the console output + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["["CRUD","HTTP","Query"]" != "null"] +*Example:* `["CRUD","HTTP","Query"]` +endif::[] +// end +| String +List + + +|=== + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/Database_config_logging_console/definition-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}definitions/Database_config_oidc/definition-before.adoc[opts=optional] @@ -36972,6 +37302,108 @@ endif::[] +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-before.adoc[opts=optional] + + +[#get__all_dbs_200_response] +=== GetAllDbs200Response + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-begin.adoc[opts=optional] + + +One of the following: + +* String +List + +* xref:#++get__all_dbs_200_response_oneOf_inner++[+get__all_dbs_200_response_oneOf_inner+] +List + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response/definition-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-before.adoc[opts=optional] + + +[#get__all_dbs_200_response_oneOf_inner] +=== GetAllDbs200ResponseOneOfInner + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-begin.adoc[opts=optional] + + +[#fields-get__all_dbs_200_response_oneOf_inner] +[cols="1,4,1"] +|=== +| Name| Description| Schema + +a| *+db_name+* + +_optional_ +a| The name of the database. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| String + + +a| *+bucket+* + +_optional_ +a| The Couchbase Server backing bucket for the database. + +[%hardbreaks] +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| String + + +a| *+state+* + +_optional_ +a| The database state. + +[%hardbreaks] +*Values:* `Online`, `Offline`, `Starting`, `Stopping`, `Resyncing` +ifeval::["null" != "null"] +*Default:* `null` +endif::[] +ifeval::["null" != "null"] +*Example:* `null` +endif::[] +// end +| String + + +|=== + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}definitions/get__all_dbs_200_response_oneOf_inner/definition-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}definitions/get_db__200_response/definition-before.adoc[opts=optional] @@ -45049,66 +45481,6 @@ Map -// markup not found, no include::{specDir}definitions/Runtime_config/definition-before.adoc[opts=optional] - - -[#Runtime_config] -=== Runtime-config - - -// markup not found, no include::{specDir}definitions/Runtime_config/definition-begin.adoc[opts=optional] - - -[#fields-Runtime_config] -[cols="1,4,1"] -|=== -| Name| Description| Schema - -a| *+logging+* + -_optional_ -a| -ifdef::desc-Startup_config_logging[] -{desc-Startup_config_logging} -endif::[] - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| xref:#++Startup_config_logging++[+Startup_config_logging+] - - -a| *+max_concurrent_replications+* + -_optional_ -a| Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - -[%hardbreaks] -ifeval::["0" != "null"] -*Default:* `0` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - -|=== - - -// markup not found, no include::{specDir}definitions/Runtime_config/definition-end.adoc[opts=optional] - - - -// markup not found, no include::{specDir}definitions/Runtime_config/definition-after.adoc[opts=optional] - - - - // markup not found, no include::{specDir}definitions/Scopes/definition-before.adoc[opts=optional] @@ -46503,21 +46875,6 @@ endif::[] | Integer -a| *+max_concurrent_replications+* + -_optional_ -a| Maximum number of concurrent replication connections allowed. If set to 0 this limit will be ignored. - -[%hardbreaks] -ifeval::["null" != "null"] -*Default:* `null` -endif::[] -ifeval::["null" != "null"] -*Example:* `null` -endif::[] -// end -| Integer - - |=== @@ -46912,7 +47269,7 @@ _optional_ a| Whether the database is online or offline. [%hardbreaks] -*Values:* `Online`, `Offline` +*Values:* `Online`, `Offline`, `Starting`, `Stopping`, `Resyncing` ifeval::["null" != "null"] *Default:* `null` endif::[] diff --git a/modules/ROOT/pages/_partials/static_restapi/generate.sh b/modules/ROOT/pages/_partials/static_restapi/generate.sh index 10432d19..01bb719a 100755 --- a/modules/ROOT/pages/_partials/static_restapi/generate.sh +++ b/modules/ROOT/pages/_partials/static_restapi/generate.sh @@ -14,12 +14,14 @@ PATH_TO_BUNDLE=${PATH_TO_BUNDLE:-${GIT_ROOT}/modules/ROOT/assets/attachments/} generate() { SPEC=$1 - redocly bundle \ - "${PATH_TO_SPECS}/${SPEC}.yaml" \ + npx '@redocly/cli' bundle \ + --config "${PATH_TO_SYNC_GATEWAY}/.redocly.yaml" \ + "${PATH_TO_SYNC_GATEWAY}/docs/api/${SPEC}.yaml" \ --dereferenced \ --output "${PATH_TO_BUNDLE}/bundled-${SPEC}.yaml" openapi-generator generate \ + --skip-validate-spec \ --generator-name asciidoc \ --input-spec "${PATH_TO_BUNDLE}/bundled-${SPEC}.yaml" \ --template-dir override/asciidoc \ diff --git a/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION b/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION index 4be2c727..8b23b8d4 100644 --- a/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION +++ b/modules/ROOT/pages/_partials/static_restapi/metric/.openapi-generator/VERSION @@ -1 +1 @@ -6.5.0 \ No newline at end of file +7.3.0 \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc b/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc index 03d4566e..dc94ef9c 100644 --- a/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/metric/index.adoc @@ -32,6 +32,7 @@ The operations are grouped in the following categories. * <> * <> +* <> [#Default] @@ -199,35 +200,36 @@ Endpoints for use with Prometheus -* xref:#+get__metrics+[Debugging/monitoring runtime stats in Prometheus Exposition format] +* xref:#+get_metrics+[Debugging/monitoring runtime stats in Prometheus Exposition format] +* xref:#+get_metrics+[Debugging/monitoring runtime stats in Prometheus Exposition format] -// markup not found, no include::{specDir}paths/get__metrics/operation-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-before.adoc[opts=optional] -[#get__metrics] +[#get_metrics] ==== Debugging/monitoring runtime stats in Prometheus Exposition format .... GET /_metrics .... -// markup not found, no include::{specDir}paths/get__metrics/operation-begin.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-begin.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-description-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-before.adoc[opts=optional] -[#get__metrics-description] +[#get_metrics-description] ===== Description -// tag::get__metrics-description[] +// tag::get_metrics-description[] -// markup not found, no include::{specDir}paths/get__metrics/operation-description-begin.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-begin.adoc[opts=optional] [markdown] @@ -242,16 +244,16 @@ Required Sync Gateway RBAC roles: -- -// markup not found, no include::{specDir}paths/get__metrics/operation-description-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-description-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-description-after.adoc[opts=optional] -// end::get__metrics-description[] +// end::get_metrics-description[] -// markup not found, no include::{specDir}paths/get__metrics/operation-parameters-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-before.adoc[opts=optional] @@ -261,31 +263,31 @@ Required Sync Gateway RBAC roles: -// markup not found, no include::{specDir}paths/get__metrics/operation-parameters-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-end.adoc[opts=optional] -// end::get__metrics-parameters[] +// end::get_metrics-parameters[] -// markup not found, no include::{specDir}paths/get__metrics/operation-parameters-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-after.adoc[opts=optional] -[#get__metrics-produces] +[#get_metrics-produces] ===== Produces * text/plain -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-before.adoc[opts=optional] -[#get__metrics-responses] +[#get_metrics-responses] ===== Responses -// tag::get__metrics-responses[] +// tag::get_metrics-responses[] -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-begin.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-begin.adoc[opts=optional] [cols="1,3,1"] @@ -300,31 +302,31 @@ a| Successfully returned stats |=== -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-responses-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-after.adoc[opts=optional] -// end::get__metrics-responses[] +// end::get_metrics-responses[] -// markup not found, no include::{specDir}paths/get__metrics/operation-security-before.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-security-before.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-security-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-security-after.adoc[opts=optional] :leveloffset: +4 -// markup not found, no include::{snippetDir}get__metrics/http-request.adoc[opts=optional] +// markup not found, no include::{snippetDir}get_metrics/http-request.adoc[opts=optional] -// markup not found, no include::{snippetDir}get__metrics/http-response.adoc[opts=optional] +// markup not found, no include::{snippetDir}get_metrics/http-response.adoc[opts=optional] :leveloffset: -4 @@ -341,10 +343,441 @@ ifdef::internal-generation[] endif::internal-generation[] -// markup not found, no include::{specDir}paths/get__metrics/operation-end.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-end.adoc[opts=optional] -// markup not found, no include::{specDir}paths/get__metrics/operation-after.adoc[opts=optional] +// markup not found, no include::{specDir}paths/get_metrics/operation-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-before.adoc[opts=optional] + + +[#get_metrics] +==== Debugging/monitoring runtime stats in Prometheus Exposition format +.... +GET /metrics +.... + + +// markup not found, no include::{specDir}paths/get_metrics/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-before.adoc[opts=optional] + + +[#get_metrics-description] +===== Description + +// tag::get_metrics-description[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns Sync Gateway statistics and other runtime variables in Prometheus Exposition format. + +Required Sync Gateway RBAC roles: + +* Sync Gateway Architect +* Sync Gateway Dev Ops +* External Stats Reader +-- + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-description-after.adoc[opts=optional] + + +// end::get_metrics-description[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-end.adoc[opts=optional] + +// end::get_metrics-parameters[] + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-parameters-after.adoc[opts=optional] + + +[#get_metrics-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-before.adoc[opts=optional] + + +[#get_metrics-responses] +===== Responses + +// tag::get_metrics-responses[] + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Successfully returned stats +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-responses-after.adoc[opts=optional] + +// end::get_metrics-responses[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get_metrics/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get_metrics/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get_metrics/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :metrics/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}metrics/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get_metrics/operation-after.adoc[opts=optional] + + + +[#Server] +=== Server + + +**{toc-title}** + + +* xref:#+get__ping+[Check if API is available] +* xref:#+head__ping+[Check if API is available] + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-before.adoc[opts=optional] + + +[#get__ping] +==== Check if API is available +.... +GET /_ping +.... + + +// markup not found, no include::{specDir}paths/get__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-before.adoc[opts=optional] + + +[#get__ping-description] +===== Description + +// tag::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-after.adoc[opts=optional] + + +// end::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-end.adoc[opts=optional] + +// end::get__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-after.adoc[opts=optional] + + +[#get__ping-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-before.adoc[opts=optional] + + +[#get__ping-responses] +===== Responses + +// tag::get__ping-responses[] + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Returned status +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-after.adoc[opts=optional] + +// end::get__ping-responses[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-after.adoc[opts=optional] + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-before.adoc[opts=optional] + + +[#head__ping] +==== Check if API is available +.... +HEAD /_ping +.... + + +// markup not found, no include::{specDir}paths/head__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-before.adoc[opts=optional] + + +[#head__ping-description] +===== Description + +// tag::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-after.adoc[opts=optional] + + +// end::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-end.adoc[opts=optional] + +// end::head__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-after.adoc[opts=optional] + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-before.adoc[opts=optional] + + +[#head__ping-responses] +===== Responses + +// tag::head__ping-responses[] + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Server is available +| + + +|=== + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-after.adoc[opts=optional] + +// end::head__ping-responses[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}head__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}head__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/HEAD/HEAD.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/HEAD/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-after.adoc[opts=optional] diff --git a/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION b/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION index 4be2c727..8b23b8d4 100644 --- a/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION +++ b/modules/ROOT/pages/_partials/static_restapi/public/.openapi-generator/VERSION @@ -1 +1 @@ -6.5.0 \ No newline at end of file +7.3.0 \ No newline at end of file diff --git a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc b/modules/ROOT/pages/_partials/static_restapi/public/index.adoc index dc66276e..211e8b5f 100644 --- a/modules/ROOT/pages/_partials/static_restapi/public/index.adoc +++ b/modules/ROOT/pages/_partials/static_restapi/public/index.adoc @@ -7198,8 +7198,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -8377,8 +8376,7 @@ a| [%hardbreaks] // end -| oas_any_type_not_mapped -Map +| xref:#++PostKeyspaceRequest++[+PostKeyspaceRequest+] |=== @@ -10230,7 +10228,9 @@ Manage server activities * xref:#+get_-+[Get server information] +* xref:#+get__ping+[Check if API is available] * xref:#+head_-+[Check if server online] +* xref:#+head__ping+[Check if API is available] @@ -10374,6 +10374,145 @@ endif::internal-generation[] +// markup not found, no include::{specDir}paths/get__ping/operation-before.adoc[opts=optional] + + +[#get__ping] +==== Check if API is available +.... +GET /_ping +.... + + +// markup not found, no include::{specDir}paths/get__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-before.adoc[opts=optional] + + +[#get__ping-description] +===== Description + +// tag::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-description-after.adoc[opts=optional] + + +// end::get__ping-description[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-end.adoc[opts=optional] + +// end::get__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-parameters-after.adoc[opts=optional] + + +[#get__ping-produces] +===== Produces + +* text/plain + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-before.adoc[opts=optional] + + +[#get__ping-responses] +===== Responses + +// tag::get__ping-responses[] + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Returned status +| xref:#++String++[+String+] + + +|=== + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/get__ping/operation-responses-after.adoc[opts=optional] + +// end::get__ping-responses[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/get__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}get__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}get__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/GET/GET.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/GET/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/get__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/get__ping/operation-after.adoc[opts=optional] + + + + // markup not found, no include::{specDir}paths/head_-/operation-before.adoc[opts=optional] @@ -10508,6 +10647,141 @@ endif::internal-generation[] + +// markup not found, no include::{specDir}paths/head__ping/operation-before.adoc[opts=optional] + + +[#head__ping] +==== Check if API is available +.... +HEAD /_ping +.... + + +// markup not found, no include::{specDir}paths/head__ping/operation-begin.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-before.adoc[opts=optional] + + +[#head__ping-description] +===== Description + +// tag::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-begin.adoc[opts=optional] + + +[markdown] +-- +Returns OK status if API is available. +-- + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-description-after.adoc[opts=optional] + + +// end::head__ping-description[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-before.adoc[opts=optional] + + + + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-end.adoc[opts=optional] + +// end::head__ping-parameters[] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-parameters-after.adoc[opts=optional] + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-before.adoc[opts=optional] + + +[#head__ping-responses] +===== Responses + +// tag::head__ping-responses[] + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-begin.adoc[opts=optional] + + +[cols="1,3,1"] +|=== +| HTTP Code | Description | Schema + +| 200 +a| Server is available +| + + +|=== + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-end.adoc[opts=optional] + + + +// markup not found, no include::{specDir}paths/head__ping/operation-responses-after.adoc[opts=optional] + +// end::head__ping-responses[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-before.adoc[opts=optional] + + + + + + +// markup not found, no include::{specDir}paths/head__ping/operation-security-after.adoc[opts=optional] + + +:leveloffset: +4 + +// markup not found, no include::{snippetDir}head__ping/http-request.adoc[opts=optional] + + +// markup not found, no include::{snippetDir}head__ping/http-response.adoc[opts=optional] + +:leveloffset: -4 + + +// file not found, no * wiremock data link :_ping/HEAD/HEAD.json[] + + +ifdef::internal-generation[] +===== Implementation + +// markup not found, no include::{specDir}_ping/HEAD/implementation.adoc[opts=optional] + + +endif::internal-generation[] + + +// markup not found, no include::{specDir}paths/head__ping/operation-end.adoc[opts=optional] + + +// markup not found, no include::{specDir}paths/head__ping/operation-after.adoc[opts=optional] + + + [#Session] === Session