From 03f3aa6c5216b244a981041a6bc84d979e66aec7 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Mon, 9 Dec 2024 06:54:31 -0800 Subject: [PATCH 01/11] CASSSIDECAR-176: OpenAPI API description --- .redocly.lint-ignore.yaml | 54 +++++++++ .../components/parameters/cdcSegment.yaml | 6 + .../components/parameters/component.yaml | 6 + .../openAPI/components/parameters/index.yaml | 6 + .../openAPI/components/parameters/jobId.yaml | 6 + .../components/parameters/keyspace.yaml | 6 + .../components/parameters/snapshot.yaml | 6 + .../openAPI/components/parameters/table.yaml | 6 + .../components/parameters/uploadId.yaml | 6 + .../components/schemas/cdcSegmentInfo.yaml | 23 ++++ .../schemas/cdcSegmentsResponse.yaml | 15 +++ .../schemas/clientConnectionEntry.yaml | 65 +++++++++++ .../schemas/connectedClientStatsResponse.yaml | 18 +++ .../components/schemas/consistencyConfig.yaml | 17 +++ .../schemas/createRestoreJobRequest.yaml | 21 ++++ .../schemas/createRestoreJobResponse.yaml | 11 ++ .../schemas/createSliceRequest.yaml | 38 +++++++ .../schemas/createSnapshotRequest.yaml | 16 +++ .../schemas/healthCheckResponse.yaml | 7 ++ .../components/schemas/nodeSettings.yaml | 37 +++++++ .../schemas/qualifiedTableName.yaml | 8 ++ .../components/schemas/replicaInfo.yaml | 21 ++++ .../schemas/replicaInfoResponse.yaml | 31 ++++++ .../schemas/restoreJobProgressResponse.yaml | 41 +++++++ .../components/schemas/restoreJobSecrets.yaml | 6 + .../components/schemas/restoreJobSummary.yaml | 29 +++++ .../components/schemas/restoredRange.yaml | 26 +++++ .../openAPI/components/schemas/ringEntry.yaml | 46 ++++++++ .../components/schemas/ringEntryList.yaml | 3 + .../components/schemas/schemaResponse.yaml | 9 ++ .../components/schemas/snapshotFileInfo.yaml | 38 +++++++ .../schemas/snapshotFileInfoList.yaml | 3 + .../schemas/ssTableImportRequest.yaml | 30 +++++ .../schemas/ssTableImportResponse.yaml | 18 +++ .../schemas/ssTableUploadResponse.yaml | 14 +++ .../schemas/storageCredentials.yaml | 18 +++ .../components/schemas/timeSkewResponse.yaml | 10 ++ .../schemas/updateRestoreJobRequest.yaml | 26 +++++ .../resources/openAPI/paths/__health.yaml | 14 +++ .../openAPI/paths/cassandra___health.yaml | 14 +++ .../openAPI/paths/cassandra_gossip.yaml | 22 ++++ .../openAPI/paths/cassandra_jmx___health.yaml | 14 +++ .../paths/cassandra_native___health.yaml | 14 +++ .../openAPI/paths/cassandra_ring.yaml | 15 +++ .../cassandra_ring_keyspaces_{keyspace}.yaml | 17 +++ .../openAPI/paths/cassandra_schema.yaml | 15 +++ .../openAPI/paths/cassandra_settings.yaml | 15 +++ ...ssandra_stats_stats_connected-clients.yaml | 15 +++ .../resources/openAPI/paths/cdc_segments.yaml | 15 +++ .../paths/cdc_segments_{cdcSegment}.yaml | 18 +++ ...e}_table_{table}_snapshots_{snapshot}.yaml | 20 ++++ ...ots_{snapshot}_components_{component}.yaml | 22 ++++ .../paths/keyspaces_{keyspace}_schema.yaml | 17 +++ ...keyspace}_tables_{table}_restore-jobs.yaml | 24 ++++ ...}_tables_{table}_restore-jobs_{jobId}.yaml | 40 +++++++ ...es_{table}_restore-jobs_{jobId}_abort.yaml | 26 +++++ ...{table}_restore-jobs_{jobId}_progress.yaml | 19 ++++ ...s_{table}_restore-jobs_{jobId}_slices.yaml | 21 ++++ ...}_tables_{table}_snapshots_{snapshot}.yaml | 63 +++++++++++ ...ots_{snapshot}_components_{component}.yaml | 21 ++++ ...pshot}_components_{index}_{component}.yaml | 22 ++++ ...paces_{keyspace}_token-range-replicas.yaml | 17 +++ .../openAPI/paths/schema_keyspaces.yaml | 16 +++ .../paths/schema_keyspaces_{keyspace}.yaml | 18 +++ .../resources/openAPI/paths/time-skew.yaml | 15 +++ .../openAPI/paths/uploads_{uploadId}.yaml | 13 +++ ...tables_{table}_components_{component}.yaml | 27 +++++ ...aces_{keyspace}_tables_{table}_import.yaml | 25 +++++ .../main/resources/openAPI/sidecarApi.yaml | 104 ++++++++++++++++++ 69 files changed, 1465 insertions(+) create mode 100644 .redocly.lint-ignore.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/component.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/index.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/jobId.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/keyspace.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/snapshot.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/table.yaml create mode 100644 server/src/main/resources/openAPI/components/parameters/uploadId.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/restoredRange.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/ringEntry.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml create mode 100644 server/src/main/resources/openAPI/paths/__health.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra___health.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_gossip.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_native___health.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_ring.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_{keyspace}.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_schema.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_settings.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml create mode 100644 server/src/main/resources/openAPI/paths/cdc_segments.yaml create mode 100644 server/src/main/resources/openAPI/paths/cdc_segments_{cdcSegment}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_schema.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml create mode 100644 server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_token-range-replicas.yaml create mode 100644 server/src/main/resources/openAPI/paths/schema_keyspaces.yaml create mode 100644 server/src/main/resources/openAPI/paths/schema_keyspaces_{keyspace}.yaml create mode 100644 server/src/main/resources/openAPI/paths/time-skew.yaml create mode 100644 server/src/main/resources/openAPI/paths/uploads_{uploadId}.yaml create mode 100644 server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml create mode 100644 server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml create mode 100644 server/src/main/resources/openAPI/sidecarApi.yaml diff --git a/.redocly.lint-ignore.yaml b/.redocly.lint-ignore.yaml new file mode 100644 index 000000000..7aee31578 --- /dev/null +++ b/.redocly.lint-ignore.yaml @@ -0,0 +1,54 @@ +# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API. +# See https://redocly.com/docs/cli/ for more information. +server/src/main/resources/openAPI/sidecarApi.yaml: + info-license: + - '#/info' + operation-4xx-response: + - '#/paths/~1__health/get/responses' + - '#/paths/~1cassandra~1__health/get/responses' + - '#/paths/~1cassandra~1native~1__health/get/responses' + - '#/paths/~1cassandra~1jmx~1__health/get/responses' + - >- + #/paths/~1keyspace~1{keyspace}~1table~1{table}~1snapshots~1{snapshot}~1components~1{component}/get/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}~1components~1{component}/get/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}~1components~1{index}~1{component}/get/responses + - >- + #/paths/~1keyspace~1{keyspace}~1table~1{table}~1snapshots~1{snapshot}/get/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}/get/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}/put/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}/delete/responses + - '#/paths/~1schema~1keyspaces/get/responses' + - '#/paths/~1cassandra~1schema/get/responses' + - '#/paths/~1schema~1keyspaces~1{keyspace}/get/responses' + - '#/paths/~1keyspaces~1{keyspace}~1schema/get/responses' + - '#/paths/~1cassandra~1ring/get/responses' + - '#/paths/~1cassandra~1ring~1keyspaces~1{keyspace}/get/responses' + - '#/paths/~1cassandra~1stats~1stats~1connected-clients/get/responses' + - '#/paths/~1keyspaces~1{keyspace}~1token-range-replicas/get/responses' + - >- + #/paths/~1uploads~1{uploadId}~1keyspaces~1{keyspace}~1tables~1{table}~1components~1{component}/put/responses + - >- + #/paths/~1uploads~1{uploadId}~1keyspaces~1{keyspace}~1tables~1{table}~1import/put/responses + - '#/paths/~1uploads~1{uploadId}/delete/responses' + - '#/paths/~1cassandra~1gossip/get/responses' + - '#/paths/~1time-skew/get/responses' + - '#/paths/~1cassandra~1settings/get/responses' + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs/post/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}~1slices/post/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}/get/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}/patch/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}~1abort/post/responses + - >- + #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}~1progress/get/responses + - '#/paths/~1cdc~1segments/get/responses' + - '#/paths/~1cdc~1segments~1{cdcSegment}/get/responses' diff --git a/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml b/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml new file mode 100644 index 000000000..b57585c74 --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml @@ -0,0 +1,6 @@ +in: path +name: cdcSegment +required: true +schema: + type: string +description: The id of a Cdc segment diff --git a/server/src/main/resources/openAPI/components/parameters/component.yaml b/server/src/main/resources/openAPI/components/parameters/component.yaml new file mode 100644 index 000000000..4e3b40f89 --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/component.yaml @@ -0,0 +1,6 @@ +in: path +name: component +required: true +schema: + type: string +description: Component ID diff --git a/server/src/main/resources/openAPI/components/parameters/index.yaml b/server/src/main/resources/openAPI/components/parameters/index.yaml new file mode 100644 index 000000000..48fb11d58 --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/index.yaml @@ -0,0 +1,6 @@ +in: path +name: index +required: true +schema: + type: string +description: An index to retrieve components from diff --git a/server/src/main/resources/openAPI/components/parameters/jobId.yaml b/server/src/main/resources/openAPI/components/parameters/jobId.yaml new file mode 100644 index 000000000..55ecd90d2 --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/jobId.yaml @@ -0,0 +1,6 @@ +in: path +name: jobId +required: true +schema: + type: string +description: Id of a job diff --git a/server/src/main/resources/openAPI/components/parameters/keyspace.yaml b/server/src/main/resources/openAPI/components/parameters/keyspace.yaml new file mode 100644 index 000000000..17c462e08 --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/keyspace.yaml @@ -0,0 +1,6 @@ +in: path +required: true +name: keyspace +schema: + type: string +description: Keyspace name diff --git a/server/src/main/resources/openAPI/components/parameters/snapshot.yaml b/server/src/main/resources/openAPI/components/parameters/snapshot.yaml new file mode 100644 index 000000000..a8a82a55b --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/snapshot.yaml @@ -0,0 +1,6 @@ +in: path +name: snapshot +required: true +schema: + type: string +description: The snapshot ID diff --git a/server/src/main/resources/openAPI/components/parameters/table.yaml b/server/src/main/resources/openAPI/components/parameters/table.yaml new file mode 100644 index 000000000..8a730e72e --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/table.yaml @@ -0,0 +1,6 @@ +in: path +name: table +required: true +schema: + type: string +description: Table name diff --git a/server/src/main/resources/openAPI/components/parameters/uploadId.yaml b/server/src/main/resources/openAPI/components/parameters/uploadId.yaml new file mode 100644 index 000000000..c3d2c3990 --- /dev/null +++ b/server/src/main/resources/openAPI/components/parameters/uploadId.yaml @@ -0,0 +1,6 @@ +in: path +name: uploadId +required: true +schema: + type: string +description: The id of a SSTable upload diff --git a/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml b/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml new file mode 100644 index 000000000..a60eafc57 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml @@ -0,0 +1,23 @@ +type: object +description: The information of a cdc segment +properties: + name: + type: string + description: Cdc segment name + example: someName + size: + type: number + description: Cdc segment size + example: 1000 + idx: + type: number + description: Cdc segment index + example: 1 + completed: + type: boolean + description: Flag indicating if the segment has been completed + example: true + lastModifiedTimestamp: + type: number + description: When was the cdc segment last modified + example: 1234 diff --git a/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml b/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml new file mode 100644 index 000000000..49895543e --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml @@ -0,0 +1,15 @@ +type: object +description: The response for list cdc segments call +properties: + host: + type: string + description: The host containing the segment + example: someName + port: + type: integer + description: The port of the host containing the segment + example: 80 + segmentInfos: + type: array + items: + $ref: ./cdcSegmentInfo.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml b/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml new file mode 100644 index 000000000..5eebab52b --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml @@ -0,0 +1,65 @@ +type: object +description: Details of a client connection +properties: + address: + type: string + description: The client address + example: 127.0.0.1 + port: + type: integer + description: The client port + example: 8080 + sslEnabled: + type: boolean + description: Flag of enabled ssl + example: true + sslCipherSuite: + type: string + description: The name of the ssl cipher suite used + example: ECDHE-ECDSA-AES256-GCM-SHA384 + sslProtocol: + type: string + description: SSL protocol being used by the client + example: SSL + protocolVersion: + type: string + description: SSL protocol version being used by the client + example: 1.2 + username: + type: string + description: User used by the client + example: someUser + requestCount: + type: number + description: Number of requests performed by the client + example: 1000 + driverName: + type: string + description: The name of the client driver + example: someDriver + driverVersion: + type: string + description: The version of the client driver + example: 2 + clientOptions: + type: object + description: Extra options used by the client + additionalProperties: true + example: + foo: bar + baz: bam + keyspaceName: + type: string + description: The client keyspace + example: someKeyspace + authenticationMode: + type: string + description: The client used authentication mode + example: basic + authenticationMetadata: + type: object + description: Extra authentication metadata used by the client + additionalProperties: true + example: + foo: bar + baz: bam diff --git a/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml b/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml new file mode 100644 index 000000000..421187cab --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml @@ -0,0 +1,18 @@ +type: object +properties: + clientConnections: + type: array + description: List of all the connected clients + items: + $ref: ./clientConnectionEntry.yaml + totalConnectedClients: + type: number + description: Number of connected clients + example: 1000 + connectionsByUser: + type: object + description: Map of number of connections by user + additionalProperties: true + example: + foo: 1000 + baz: 2000 diff --git a/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml b/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml new file mode 100644 index 000000000..cd2ecf5d9 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml @@ -0,0 +1,17 @@ +type: object +properties: + consistencyLevel: + type: string + description: Cassandra consistency level + enum: + - ONE + - TWO + - LOCAL_ONE + - LOCAL_QUORUM + - EACH_QUORUM + - QUORUM + - ALL + localDatacenter: + type: string + description: The local datacenter + example: DC1 diff --git a/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml b/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml new file mode 100644 index 000000000..d759056a3 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml @@ -0,0 +1,21 @@ +type: object +properties: + jobId: + type: string + format: uuid + description: Id of the job to be restored + example: 7bdaf3e4-27e6-4268-982e-79b3e450a1cb + jobAgent: + type: string + description: The agent of the job + example: someJobAgent + secrets: + $ref: ./restoreJobSecrets.yaml + importOptions: + $ref: ./ssTableImportRequest.yaml + expireAtInMillis: + type: number + description: When should the job expire + example: 1000 + consistencyConfig: + $ref: ./consistencyConfig.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml b/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml new file mode 100644 index 000000000..e64a0c6c1 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml @@ -0,0 +1,11 @@ +type: object +properties: + jobId: + type: string + format: uuid + description: Id of the job to be restored + example: 7bdaf3e4-27e6-4268-982e-79b3e450a1cb + status: + type: string + description: Status of the job + example: OK diff --git a/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml b/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml new file mode 100644 index 000000000..e73e87406 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml @@ -0,0 +1,38 @@ +type: object +properties: + sliceId: + type: string + description: The id of the slice + example: someSliceId + bucketId: + type: integer + description: The bucket id for the slice + example: 1 + bucket: + type: string + description: Bucket name + example: someBuclet + key: + type: string + description: Key name + example: someKey + checksum: + type: string + description: Checksum of the slice + example: someChecksum + startToken: + type: number + description: Starting token + example: 1 + endToken: + type: number + description: End token + example: 100 + uncompressedSize: + type: number + description: Uncompressed size of the slice + example: 100 + compressedSize: + type: number + description: Compressed size of the slice + example: 50 diff --git a/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml b/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml new file mode 100644 index 000000000..d3e808a42 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml @@ -0,0 +1,16 @@ +type: object +properties: + snapshotName: + type: string + description: Name for the snapshot + example: someSnapshot + includeSecondaryIndexFiles: + type: boolean + description: Whether or not to include the secondary index files in the snapshot + example: someSnapshot + qualifiedTableName: + $ref: ./qualifiedTableName.yaml + ttl: + type: string + description: Time to live for the snapshot + example: 123 diff --git a/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml b/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml new file mode 100644 index 000000000..9fb254ff0 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml @@ -0,0 +1,7 @@ +type: object +properties: + status: + type: string + description: Health Status + examples: + - OK diff --git a/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml b/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml new file mode 100644 index 000000000..c8ef0055d --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml @@ -0,0 +1,37 @@ +type: object +properties: + releaseVersion: + type: string + description: Version of the release present in the node + example: 5 + partitioner: + type: string + description: Partitioner used in the node + example: partitioner + datacenter: + type: string + description: Node datacenter + example: DC1 + rpcAddress: + type: string + description: Node rpcAddress + example: 127.0.0.1 + rpcPort: + type: integer + description: Node port + example: 8080 + tokens: + type: array + description: Tokens present in the node + items: + type: string + example: + - a001 + - a002 + sidecar: + type: object + description: Node port + additionalProperties: true + example: + foo: bar + bam: baz diff --git a/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml b/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml new file mode 100644 index 000000000..d53364c2f --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml @@ -0,0 +1,8 @@ +type: object +properties: + keyspace: + type: string + example: someKeyspace + table: + type: string + example: someTable diff --git a/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml b/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml new file mode 100644 index 000000000..891766bb8 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml @@ -0,0 +1,21 @@ +type: object +properties: + start: + type: string + description: Token Range start + example: 1 + end: + type: string + description: Token Range end + example: 1000 + replicas: + type: object + additionalProperties: true + description: Map with all the replicas information + example: + replica1: + - foo + - bar + replica2: + - bam + - baz diff --git a/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml b/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml new file mode 100644 index 000000000..da36a94ec --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml @@ -0,0 +1,31 @@ +type: object +properties: + readReplicas: + type: array + description: List of read replicas information + items: + $ref: ./replicaInfo.yaml + writeReplicas: + type: array + description: List of write replicas information + items: + $ref: ./replicaInfo.yaml + replicas: + type: object + additionalProperties: true + description: Map with all the replicas metadata + example: + replica1: + state: OK + status: UP + fqdn: somefqdn + address: 127.0.0.1 + port: 80 + datacenter: DC1 + replica2: + state: OK + status: UP + fqdn: somefqdn + address: 127.0.0.1 + port: 80 + datacenter: DC1 diff --git a/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml b/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml new file mode 100644 index 000000000..61a78791f --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml @@ -0,0 +1,41 @@ +type: object +properties: + message: + type: string + description: Message about the progress of the restore job + example: Some message + status: + type: string + description: Job status + enum: + - SATISFIED + - PENDING + - FAILED + failedRanges: + type: array + description: Failed ranges + items: + $ref: ./restoredRange.yaml + abortedRanges: + type: array + description: Aborted ranges + items: + $ref: ./restoredRange.yaml + pendingRanges: + type: array + description: Pending ranges + items: + $ref: ./restoredRange.yaml + succeededRanges: + type: array + description: Succeeded ranges + items: + $ref: ./restoredRange.yaml + expireAtInMillis: + type: number + description: When should the job expire + example: 1000 + sliceCount: + type: number + description: Number of slices + example: 100 diff --git a/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml b/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml new file mode 100644 index 000000000..e849a482b --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml @@ -0,0 +1,6 @@ +type: object +properties: + writeCredentials: + $ref: ./storageCredentials.yaml + readCredentials: + $ref: ./storageCredentials.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml b/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml new file mode 100644 index 000000000..c44b51116 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml @@ -0,0 +1,29 @@ +type: object +properties: + createdAt: + type: string + description: Time when the restore job was created + example: 1234 + jobId: + type: string + format: uuid + description: Id of the job to be restored + example: 7bdaf3e4-27e6-4268-982e-79b3e450a1cb + jobAgent: + type: string + description: The agent executing the job + example: someAgent + keyspace: + type: string + description: The job's keyspace + example: someKeyspace + table: + type: string + description: The job's table + example: someTable + secrets: + $ref: ./restoreJobSecrets.yaml + status: + type: string + description: Status of the job + example: OK diff --git a/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml b/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml new file mode 100644 index 000000000..ffbab4092 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml @@ -0,0 +1,26 @@ +type: object +properties: + sliceId: + type: string + description: The id of the slice + example: someSliceId + bucketId: + type: integer + description: The id of the bucket + example: 1 + bucket: + type: string + description: The bucket name + example: somebucket + key: + type: string + description: The key of the range + example: someKey + startToken: + type: number + description: The first token of the range + example: 1 + endToken: + type: number + description: The last token of the range + example: 100 diff --git a/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml b/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml new file mode 100644 index 000000000..c07460ae4 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml @@ -0,0 +1,46 @@ +type: object +properties: + datacenter: + type: string + description: The instance datacenter + example: DC1 + address: + type: string + description: The instance address + example: 127.0.0.1 + port: + type: integer + description: The instance port + example: 8080 + rack: + type: string + description: The instance rack + example: rack1 + status: + type: string + description: The instance status + example: OK + state: + type: string + description: The instance state + example: UP + load: + type: string + description: The instance load + example: 0 + owns: + type: string + description: The instance owner + example: ownerName + token: + type: string + description: The instance owned token + example: 1 + fdqn: + type: string + description: The instance fdqn + example: fdqn1 + hostId: + type: string + description: The instance hostId + example: hostId1 diff --git a/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml b/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml new file mode 100644 index 000000000..c6a7377c1 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml @@ -0,0 +1,3 @@ +type: array +items: + $ref: ./ringEntry.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml b/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml new file mode 100644 index 000000000..4bb9b84a8 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml @@ -0,0 +1,9 @@ +type: object +properties: + keyspace: + type: string + example: someKeyspace + schema: + type: string + description: CQL schema + example: diff --git a/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml new file mode 100644 index 000000000..c01c80a46 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml @@ -0,0 +1,38 @@ +type: object +properties: + size: + type: number + description: The size of the snapshot file + example: 123 + host: + type: string + description: The host hosting the snapshot file + example: 127.0.0.1 + port: + type: integer + description: The port of the host hosting the snapshot file + example: 8080 + dataDirIndex: + type: integer + description: The index of the data directory containing the snapshot file + example: 1 + snapshotName: + type: string + description: The name of the snapshot + example: snapshot-123 + keySpaceName: + type: string + description: The keyspace the snapshot file pertains to + example: someKeyspace + tableName: + type: string + description: The name of the table the snapshot file pertains to + example: someTable + fileName: + type: string + description: The name of the snapshot file + example: snapshotFile + componentDownloadUrl: + type: string + description: The url to download the snapshot file from + example: http://127.0.0.1/api/v1/keyspaces/ks/tables/t/snapshots/s/components/c diff --git a/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml new file mode 100644 index 000000000..cecca48c0 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml @@ -0,0 +1,3 @@ +type: array +items: + $ref: ./snapshotFileInfo.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml b/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml new file mode 100644 index 000000000..b46701345 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml @@ -0,0 +1,30 @@ +type: object +properties: + resetLevel: + type: boolean + description: Flag stating the reset level + example: true + clearRepaired: + type: boolean + description: Flag to clear the repaired files + example: true + verifySSTables: + type: boolean + description: Flag to verify the SSTables + example: true + verifyTokens: + type: boolean + description: Flag to verify the tokens + example: true + invalidateCaches: + type: boolean + description: Flag to invalidate the caches + example: true + extendedVerify: + type: boolean + description: Flag to extend the verify + example: true + copyData: + type: boolean + description: Flag to copy the data + example: true diff --git a/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml b/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml new file mode 100644 index 000000000..313ce2563 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml @@ -0,0 +1,18 @@ +type: object +properties: + success: + type: boolean + description: Flag with the success of the import + example: true + uploadId: + type: string + description: Id of the upload + example: someId + keyspace: + type: string + description: Name of the SSTable keyspace + example: someKeyspace + tableName: + type: string + description: Name of the SSTable table + example: someTable diff --git a/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml b/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml new file mode 100644 index 000000000..a9c5a2d2d --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml @@ -0,0 +1,14 @@ +type: object +properties: + uploadId: + type: string + description: Id of the upload + example: someId + uploadSizeBytes: + type: number + description: Number of bytes of the uploaded file + example: 1000 + serviceTimeMillis: + type: number + description: Time that took to upload the file in millis + example: 1000 diff --git a/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml b/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml new file mode 100644 index 000000000..0afceeb5f --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml @@ -0,0 +1,18 @@ +type: object +properties: + accessKeyId: + type: string + description: Access Key Id + example: someAccessKey + secretAccessKey: + type: string + description: Secret Access Key + example: someSecret + sessionToken: + type: string + description: Session token + example: someToken + region: + type: string + description: Storage region + example: someSecret diff --git a/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml b/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml new file mode 100644 index 000000000..2bee16bfc --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml @@ -0,0 +1,10 @@ +type: object +properties: + currentTime: + type: number + description: Current time on the instance + example: 1000 + allowableSkewInMinutes: + type: integer + description: Allowable skew time in minutes + example: 10 diff --git a/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml b/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml new file mode 100644 index 000000000..62eea1b61 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml @@ -0,0 +1,26 @@ +type: object +properties: + jobAgent: + type: string + description: The agent of the job + example: someJobAgent + secrets: + $ref: ./restoreJobSecrets.yaml + status: + type: string + enum: + - CREATED + - STAGE_READY + - STAGED + - IMPORT_READY + - FAILED + - ABORTED + - SUCCEEDED + expireAtInMillis: + type: number + description: When should the job expire + example: 1000 + sliceCount: + type: number + description: Number of slices + example: 100 diff --git a/server/src/main/resources/openAPI/paths/__health.yaml b/server/src/main/resources/openAPI/paths/__health.yaml new file mode 100644 index 000000000..68c6dfbed --- /dev/null +++ b/server/src/main/resources/openAPI/paths/__health.yaml @@ -0,0 +1,14 @@ +get: + tags: + - healthchecks + operationId: healthcheck + description: Check health + summary: Check health + security: [] + responses: + '200': + description: Healthy + content: + application/json: + schema: + $ref: ../components/schemas/healthCheckResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra___health.yaml b/server/src/main/resources/openAPI/paths/cassandra___health.yaml new file mode 100644 index 000000000..7802817bc --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra___health.yaml @@ -0,0 +1,14 @@ +get: + tags: + - healthchecks + operationId: cassandraHealthcheck + description: Check health + summary: Check health + security: [] + responses: + '200': + description: Healthy + content: + application/json: + schema: + $ref: ../components/schemas/healthCheckResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml b/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml new file mode 100644 index 000000000..bd60c9c5b --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml @@ -0,0 +1,22 @@ +get: + tags: + - gossip + operationId: gossipInfo + description: Get Gossip info + summary: Get Gossip info + security: + - mTLS: [] + responses: + '200': + description: Success + content: + application/json: + schema: + type: object + additionalProperties: true + description: Map with all the instances gossip information + example: + instance1: + heartbeat: bar + instance2: + heartbeat: baz diff --git a/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml new file mode 100644 index 000000000..9f2b26b69 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml @@ -0,0 +1,14 @@ +get: + tags: + - healthchecks + operationId: jmxHealthcheck + description: Check health + summary: Check health + security: [] + responses: + '200': + description: Healthy + content: + application/json: + schema: + $ref: ../components/schemas/healthCheckResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml new file mode 100644 index 000000000..78a9f6e3b --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml @@ -0,0 +1,14 @@ +get: + tags: + - healthchecks + operationId: cassandraNativeHealthcheck + description: Check health + summary: Check health + security: [] + responses: + '200': + description: Healthy + content: + application/json: + schema: + $ref: ../components/schemas/healthCheckResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring.yaml new file mode 100644 index 000000000..d5b1b9665 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_ring.yaml @@ -0,0 +1,15 @@ +get: + tags: + - ring + operationId: getRing + description: Gets the ring status + summary: Gets the ring status + security: + - mTLS: [] + responses: + '200': + description: Ring status + content: + application/json: + schema: + $ref: ../components/schemas/ringEntryList.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_{keyspace}.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_{keyspace}.yaml new file mode 100644 index 000000000..34d43caf1 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_{keyspace}.yaml @@ -0,0 +1,17 @@ +get: + tags: + - ring + operationId: getRingPerKeyspace + description: Gets the ring status for a keyspace + summary: Gets the ring status for a keyspace + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + responses: + '200': + description: Ring status + content: + application/json: + schema: + $ref: ../components/schemas/ringEntryList.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_schema.yaml b/server/src/main/resources/openAPI/paths/cassandra_schema.yaml new file mode 100644 index 000000000..6beb85d35 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_schema.yaml @@ -0,0 +1,15 @@ +get: + tags: + - keyspaces + operationId: listAllKeyspaces + description: Gets all the keyspaces from the database. + summary: Gets all the keyspaces from the database. + security: + - mTLS: [] + responses: + '200': + description: List of keyspaces + content: + application/json: + schema: + $ref: ../components/schemas/schemaResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_settings.yaml b/server/src/main/resources/openAPI/paths/cassandra_settings.yaml new file mode 100644 index 000000000..e7c22d4f9 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_settings.yaml @@ -0,0 +1,15 @@ +get: + tags: + - settings + operationId: nodeSettings + description: Get the settings of a node + summary: Get the settings of a node + security: + - mTLS: [] + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: ../components/schemas/nodeSettings.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml new file mode 100644 index 000000000..d0c987c13 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml @@ -0,0 +1,15 @@ +get: + tags: + - stats + operationId: getClientStats + description: Gets stats of connected clients + summary: Gets stats of connected clients + security: + - mTLS: [] + responses: + '200': + description: Ring status + content: + application/json: + schema: + $ref: ../components/schemas/connectedClientStatsResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cdc_segments.yaml b/server/src/main/resources/openAPI/paths/cdc_segments.yaml new file mode 100644 index 000000000..97449a77e --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cdc_segments.yaml @@ -0,0 +1,15 @@ +get: + tags: + - cdc + operationId: listCdcSegment + description: Endpoint used to list the pending cdc segments + summary: Endpoint used to list the pending cdc segments + security: + - mTLS: [] + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: ../components/schemas/cdcSegmentsResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/cdc_segments_{cdcSegment}.yaml b/server/src/main/resources/openAPI/paths/cdc_segments_{cdcSegment}.yaml new file mode 100644 index 000000000..a2d171278 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cdc_segments_{cdcSegment}.yaml @@ -0,0 +1,18 @@ +get: + tags: + - cdc + operationId: streamCdcSegment + description: Endpoint get a cdc segment + summary: Endpoint get a cdc segment + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/cdcSegment.yaml + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + type: string + format: binary diff --git a/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml b/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml new file mode 100644 index 000000000..a843f899b --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml @@ -0,0 +1,20 @@ +get: + tags: + - snapshots + operationId: deprecatedGetSnapshots + description: Deprecated endpoint to get the info of a snapshot. + summary: Deprecated endpoint to get the info of a snapshot. + security: + - mTLS: [] + deprecated: true + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + responses: + '200': + description: Stream of the component + content: + application/octet-stream: + schema: + $ref: ../components/schemas/snapshotFileInfoList.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml b/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml new file mode 100644 index 000000000..88a839ec3 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml @@ -0,0 +1,22 @@ +get: + tags: + - components + operationId: deprecatedGetComponent + description: Deprecated endpoint to get the component from a snapshot. + summary: Deprecated endpoint to get the component from a snapshot. + security: + - mTLS: [] + deprecated: true + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + - $ref: ../components/parameters/component.yaml + responses: + '200': + description: Stream of the component + content: + application/octet-stream: + schema: + type: string + format: binary diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_schema.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_schema.yaml new file mode 100644 index 000000000..e07967581 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_schema.yaml @@ -0,0 +1,17 @@ +get: + tags: + - keyspaces + operationId: getAKeyspaces + description: Gets a keyspace schema. + summary: Gets a keyspace schema. + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + responses: + '200': + description: List of keyspaces + content: + application/json: + schema: + $ref: ../components/schemas/schemaResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml new file mode 100644 index 000000000..4a80578e7 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml @@ -0,0 +1,24 @@ +post: + tags: + - jobs + operationId: createRestoreJob + description: Endpoint used to create a restore job + summary: Endpoint used to create a restore job + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + requestBody: + description: Restore Job Payload + content: + application/json: + schema: + $ref: ../components/schemas/createRestoreJobRequest.yaml + responses: + '200': + description: Job Restored + content: + application/json: + schema: + $ref: ../components/schemas/createRestoreJobResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml new file mode 100644 index 000000000..04574a159 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml @@ -0,0 +1,40 @@ +get: + tags: + - jobs + operationId: getRestoreJob + description: Endpoint used to create a restore job info + summary: Endpoint used to create a restore job info + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/jobId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + responses: + '200': + description: Job Restored + content: + application/json: + schema: + $ref: ../components/schemas/restoreJobSummary.yaml +patch: + tags: + - jobs + operationId: patchRestoreJob + description: Endpoint used to patch a restore job info + summary: Endpoint used to patch a restore job info + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/jobId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + requestBody: + description: Patch restore Job Payload + content: + application/json: + schema: + $ref: ../components/schemas/updateRestoreJobRequest.yaml + responses: + '200': + description: Success diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml new file mode 100644 index 000000000..c403017d6 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml @@ -0,0 +1,26 @@ +post: + tags: + - jobs + operationId: abortRestoreJob + description: Endpoint used to abort a restore job + summary: Endpoint used to abort a restore job + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/jobId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + requestBody: + description: Restore Job Payload + content: + application/json: + schema: + type: object + properties: + reason: + type: string + description: The reason for aborting the restore job + example: Some Reason + responses: + '200': + description: Success diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml new file mode 100644 index 000000000..ae61dfec8 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml @@ -0,0 +1,19 @@ +get: + tags: + - jobs + operationId: getRestoreJobProgress + description: Endpoint used to get a restore job progress info + summary: Endpoint used to get a restore job progress info + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/jobId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + responses: + '200': + description: Job restore progress info + content: + application/json: + schema: + $ref: ../components/schemas/restoreJobProgressResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml new file mode 100644 index 000000000..34a35c696 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml @@ -0,0 +1,21 @@ +post: + tags: + - jobs + operationId: getRestoreJobSlices + description: Endpoint used to create a restore job slice + summary: Endpoint used to create a restore job slice + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/jobId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + requestBody: + description: Restore Job Payload + content: + application/json: + schema: + $ref: ../components/schemas/createSliceRequest.yaml + responses: + '200': + description: Success diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml new file mode 100644 index 000000000..57d0c49ef --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml @@ -0,0 +1,63 @@ +get: + tags: + - snapshots + operationId: getSnapshots + description: Endpoint to get the info of a snapshot. + summary: Endpoint to get the info of a snapshot. + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + responses: + '200': + description: Stream of the component + content: + application/octet-stream: + schema: + $ref: ../components/schemas/snapshotFileInfoList.yaml +delete: + tags: + - snapshots + operationId: deleteSnapshot + description: Endpoint to delete a snapshot. + summary: Endpoint to delete a snapshot. + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + responses: + '200': + description: Snapshot was successfully deleted +put: + tags: + - snapshots + operationId: createSnapshot + description: Creates a snapshot + summary: Creates a snapshot + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + requestBody: + description: Restore Job Payload + content: + application/json: + schema: + $ref: ../components/schemas/createSnapshotRequest.yaml + responses: + '200': + description: Snapshot created + content: + application/json: + schema: + type: object + properties: + result: + type: string + example: Success diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml new file mode 100644 index 000000000..b045059a1 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml @@ -0,0 +1,21 @@ +get: + tags: + - components + operationId: getComponent + description: Endpoint to get the component from a snapshot. + summary: Endpoint to get the component from a snapshot. + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + - $ref: ../components/parameters/component.yaml + responses: + '200': + description: Stream of the component + content: + application/octet-stream: + schema: + type: string + format: binary diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml new file mode 100644 index 000000000..7769f4993 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml @@ -0,0 +1,22 @@ +get: + tags: + - components + operationId: getComponentFromIndex + description: Endpoint to get the component from a snapshot using a specific index. + summary: Endpoint to get the component from a snapshot using a specific index. + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/snapshot.yaml + - $ref: ../components/parameters/index.yaml + - $ref: ../components/parameters/component.yaml + responses: + '200': + description: Stream of the component + content: + application/octet-stream: + schema: + type: string + format: binary diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_token-range-replicas.yaml b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_token-range-replicas.yaml new file mode 100644 index 000000000..13e022d4a --- /dev/null +++ b/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_token-range-replicas.yaml @@ -0,0 +1,17 @@ +get: + tags: + - tokenrange + operationId: getTokenRangeReplica + description: Gets the token range replicas for a given keyspace + summary: Gets the token range replicas for a given keyspace + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + responses: + '200': + description: Ring status + content: + application/json: + schema: + $ref: ../components/schemas/replicaInfoResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml new file mode 100644 index 000000000..e794a887b --- /dev/null +++ b/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml @@ -0,0 +1,16 @@ +get: + tags: + - keyspaces + operationId: deprecatedListAllKeyspaces + description: Gets all the keyspaces from the database. + summary: Gets all the keyspaces from the database. + security: + - mTLS: [] + deprecated: true + responses: + '200': + description: List of keyspaces + content: + application/json: + schema: + $ref: ../components/schemas/schemaResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces_{keyspace}.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces_{keyspace}.yaml new file mode 100644 index 000000000..4927f7cb3 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/schema_keyspaces_{keyspace}.yaml @@ -0,0 +1,18 @@ +get: + tags: + - keyspaces + operationId: deprecatedGetAKeyspaces + description: Gets a keyspace schema. + summary: Gets a keyspace schema. + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/keyspace.yaml + deprecated: true + responses: + '200': + description: List of keyspaces + content: + application/json: + schema: + $ref: ../components/schemas/schemaResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/time-skew.yaml b/server/src/main/resources/openAPI/paths/time-skew.yaml new file mode 100644 index 000000000..df4bff4e0 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/time-skew.yaml @@ -0,0 +1,15 @@ +get: + tags: + - gossip + operationId: timeSkew + description: Get Gossip info + summary: Get Gossip info + security: + - mTLS: [] + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: ../components/schemas/timeSkewResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/uploads_{uploadId}.yaml b/server/src/main/resources/openAPI/paths/uploads_{uploadId}.yaml new file mode 100644 index 000000000..f12e62e43 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/uploads_{uploadId}.yaml @@ -0,0 +1,13 @@ +delete: + tags: + - sstables + operationId: ssTableCleanup + description: Clean up an SSTable + summary: Clean up an SSTable + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/uploadId.yaml + responses: + '200': + description: Uploaded file successfully diff --git a/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml b/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml new file mode 100644 index 000000000..4236c2d42 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml @@ -0,0 +1,27 @@ +put: + tags: + - sstables + operationId: uploadSSTable + description: Upload an SSTable + summary: Upload an SSTable + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/uploadId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + - $ref: ../components/parameters/component.yaml + requestBody: + description: SSLTable to upload + content: + application/octet-stream: + schema: + type: string + format: binary + responses: + '200': + description: Uploaded file successfully + content: + application/json: + schema: + $ref: ../components/schemas/ssTableUploadResponse.yaml diff --git a/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml b/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml new file mode 100644 index 000000000..bc5cb03e5 --- /dev/null +++ b/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml @@ -0,0 +1,25 @@ +put: + tags: + - sstables + operationId: importSSTable + description: Import an SSTable + summary: Import an SSTable + security: + - mTLS: [] + parameters: + - $ref: ../components/parameters/uploadId.yaml + - $ref: ../components/parameters/keyspace.yaml + - $ref: ../components/parameters/table.yaml + requestBody: + description: SSLTable to upload + content: + application/octet-stream: + schema: + $ref: ../components/schemas/ssTableImportRequest.yaml + responses: + '200': + description: Uploaded file successfully + content: + application/json: + schema: + $ref: ../components/schemas/ssTableImportResponse.yaml diff --git a/server/src/main/resources/openAPI/sidecarApi.yaml b/server/src/main/resources/openAPI/sidecarApi.yaml new file mode 100644 index 000000000..3ee3ec182 --- /dev/null +++ b/server/src/main/resources/openAPI/sidecarApi.yaml @@ -0,0 +1,104 @@ +openapi: 3.1.0 +info: + title: Cassandra Sidecar API + description: Cassandra Sidecar API API description. + version: 1.0.0 +servers: + - url: https://localhost:8080/api/v1 + description: Localhost server +tags: + - name: healthchecks + description: Different healthchecks endpoints + - name: jobs + description: Restore jobs operations + - name: components + description: Component endpoints + - name: snapshots + description: Snapshot endpoints + - name: keyspaces + description: Keyspaces endpoints + - name: ring + description: Ring endpoints + - name: stats + description: Stats endpoints + - name: sstables + description: SSTables endpoints + - name: tokenrange + description: Token Range endpoints + - name: gossip + description: Gossip endpoints + - name: settings + description: Settings endpoints + - name: cdc + description: CDC endpoints +paths: + /__health: + $ref: paths/__health.yaml + /cassandra/__health: + $ref: paths/cassandra___health.yaml + /cassandra/native/__health: + $ref: paths/cassandra_native___health.yaml + /cassandra/jmx/__health: + $ref: paths/cassandra_jmx___health.yaml + /keyspace/{keyspace}/table/{table}/snapshots/{snapshot}/components/{component}: + $ref: >- + paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml + /keyspaces/{keyspace}/tables/{table}/snapshots/{snapshot}/components/{component}: + $ref: >- + paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml + /keyspaces/{keyspace}/tables/{table}/snapshots/{snapshot}/components/{index}/{component}: + $ref: >- + paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml + /keyspace/{keyspace}/table/{table}/snapshots/{snapshot}: + $ref: paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml + /keyspaces/{keyspace}/tables/{table}/snapshots/{snapshot}: + $ref: paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml + /schema/keyspaces: + $ref: paths/schema_keyspaces.yaml + /cassandra/schema: + $ref: paths/cassandra_schema.yaml + /schema/keyspaces/{keyspace}: + $ref: paths/schema_keyspaces_{keyspace}.yaml + /keyspaces/{keyspace}/schema: + $ref: paths/keyspaces_{keyspace}_schema.yaml + /cassandra/ring: + $ref: paths/cassandra_ring.yaml + /cassandra/ring/keyspaces/{keyspace}: + $ref: paths/cassandra_ring_keyspaces_{keyspace}.yaml + /cassandra/stats/stats/connected-clients: + $ref: paths/cassandra_stats_stats_connected-clients.yaml + /keyspaces/{keyspace}/token-range-replicas: + $ref: paths/keyspaces_{keyspace}_token-range-replicas.yaml + /uploads/{uploadId}/keyspaces/{keyspace}/tables/{table}/components/{component}: + $ref: >- + paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml + /uploads/{uploadId}/keyspaces/{keyspace}/tables/{table}/import: + $ref: paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml + /uploads/{uploadId}: + $ref: paths/uploads_{uploadId}.yaml + /cassandra/gossip: + $ref: paths/cassandra_gossip.yaml + /time-skew: + $ref: paths/time-skew.yaml + /cassandra/settings: + $ref: paths/cassandra_settings.yaml + /keyspaces/{keyspace}/tables/{table}/restore-jobs: + $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml + /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}/slices: + $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml + /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}: + $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml + /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}/abort: + $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml + /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}/progress: + $ref: >- + paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml + /cdc/segments: + $ref: paths/cdc_segments.yaml + /cdc/segments/{cdcSegment}: + $ref: paths/cdc_segments_{cdcSegment}.yaml +components: + securitySchemes: + mTLS: + description: mTLS authentication + type: mutualTLS From 2ac8967d20306ab0ab484f39cd3e15945372a2bd Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 13 Dec 2024 11:48:25 -0800 Subject: [PATCH 02/11] Fix paths --- server/build.gradle | 16 +++++++ ...=> cassandra_ring_keyspaces_keyspace.yaml} | 0 ...ent}.yaml => cdc_segments_cdcSegment.yaml} | 0 ...space_table_table_snapshots_snapshot.yaml} | 0 ...pshots_snapshot_components_component.yaml} | 0 ...ma.yaml => keyspaces_keyspace_schema.yaml} | 0 ...s_keyspace_tables_table_restore-jobs.yaml} | 0 ...pace_tables_table_restore-jobs_jobId.yaml} | 0 ...ables_table_restore-jobs_jobId_abort.yaml} | 0 ...es_table_restore-jobs_jobId_progress.yaml} | 0 ...bles_table_restore-jobs_jobId_slices.yaml} | 0 ...pace_tables_table_snapshots_snapshot.yaml} | 0 ...pshots_snapshot_components_component.yaml} | 0 ..._snapshot_components_index_component.yaml} | 0 ...spaces_keyspace_token-range-replicas.yaml} | 0 ...e}.yaml => schema_keyspaces_keyspace.yaml} | 0 ..._{uploadId}.yaml => uploads_uploadId.yaml} | 0 ...ce_tables_table_components_component.yaml} | 0 ...yspaces_keyspace_tables_table_import.yaml} | 0 .../main/resources/openAPI/sidecarApi.yaml | 46 +++++++++---------- 20 files changed, 39 insertions(+), 23 deletions(-) rename server/src/main/resources/openAPI/paths/{cassandra_ring_keyspaces_{keyspace}.yaml => cassandra_ring_keyspaces_keyspace.yaml} (100%) rename server/src/main/resources/openAPI/paths/{cdc_segments_{cdcSegment}.yaml => cdc_segments_cdcSegment.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml => keyspace_keyspace_table_table_snapshots_snapshot.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml => keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_schema.yaml => keyspaces_keyspace_schema.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml => keyspaces_keyspace_tables_table_restore-jobs.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml => keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml => keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml => keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml => keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml => keyspaces_keyspace_tables_table_snapshots_snapshot.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml => keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml => keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml} (100%) rename server/src/main/resources/openAPI/paths/{keyspaces_{keyspace}_token-range-replicas.yaml => keyspaces_keyspace_token-range-replicas.yaml} (100%) rename server/src/main/resources/openAPI/paths/{schema_keyspaces_{keyspace}.yaml => schema_keyspaces_keyspace.yaml} (100%) rename server/src/main/resources/openAPI/paths/{uploads_{uploadId}.yaml => uploads_uploadId.yaml} (100%) rename server/src/main/resources/openAPI/paths/{uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml => uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml} (100%) rename server/src/main/resources/openAPI/paths/{uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml => uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml} (100%) diff --git a/server/build.gradle b/server/build.gradle index 54c4c7bb4..68522755b 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -30,6 +30,8 @@ plugins { id('maven-publish') // and produces a docker image id('com.google.cloud.tools.jib') version '3.4.4' + // openAPI + id "org.openapi.generator" version "6.6.0" } sourceCompatibility = JavaVersion.VERSION_11 @@ -254,3 +256,17 @@ checkstyleContainerTest.onlyIf { "true" != System.getenv("skipContainerTest") } spotbugsContainerTest.onlyIf { "true" != System.getenv("skipContainerTest") } check.dependsOn containerTest, integrationTest, jacocoTestReport + +// openAPI +openApiValidate { + inputSpec.set("$rootDir/server/src/main/resources/openAPI/sidecarApi.yaml") + recommend.set(true) +} + +openApiGenerate { + generatorName.set("html2") + inputSpec.set("$rootDir/server/src/main/resources/openAPI/sidecarApi.yaml") + outputDir.set("$buildDir/apiDocs") +} + +compileJava.dependsOn tasks.openApiGenerate \ No newline at end of file diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_{keyspace}.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_{keyspace}.yaml rename to server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml diff --git a/server/src/main/resources/openAPI/paths/cdc_segments_{cdcSegment}.yaml b/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/cdc_segments_{cdcSegment}.yaml rename to server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml rename to server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml rename to server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_schema.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_schema.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml diff --git a/server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_token-range-replicas.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/keyspaces_{keyspace}_token-range-replicas.yaml rename to server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces_{keyspace}.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/schema_keyspaces_{keyspace}.yaml rename to server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml diff --git a/server/src/main/resources/openAPI/paths/uploads_{uploadId}.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/uploads_{uploadId}.yaml rename to server/src/main/resources/openAPI/paths/uploads_uploadId.yaml diff --git a/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml rename to server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml diff --git a/server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml similarity index 100% rename from server/src/main/resources/openAPI/paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml rename to server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml diff --git a/server/src/main/resources/openAPI/sidecarApi.yaml b/server/src/main/resources/openAPI/sidecarApi.yaml index 3ee3ec182..17e223726 100644 --- a/server/src/main/resources/openAPI/sidecarApi.yaml +++ b/server/src/main/resources/openAPI/sidecarApi.yaml @@ -41,41 +41,41 @@ paths: /cassandra/jmx/__health: $ref: paths/cassandra_jmx___health.yaml /keyspace/{keyspace}/table/{table}/snapshots/{snapshot}/components/{component}: - $ref: >- - paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}_components_{component}.yaml + $ref: "paths/keyspace_keyspace_table_table_snapshots_snapshot_compon\ + ents_component.yaml" /keyspaces/{keyspace}/tables/{table}/snapshots/{snapshot}/components/{component}: - $ref: >- - paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{component}.yaml + $ref: "paths/keyspaces_keyspace_tables_table_snapshots_snapshot_comp\ + onents_component.yaml" /keyspaces/{keyspace}/tables/{table}/snapshots/{snapshot}/components/{index}/{component}: - $ref: >- - paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}_components_{index}_{component}.yaml + $ref: "paths/keyspaces_keyspace_tables_table_snapshots_snapshot_comp\ + onents_index_component.yaml" /keyspace/{keyspace}/table/{table}/snapshots/{snapshot}: - $ref: paths/keyspace_{keyspace}_table_{table}_snapshots_{snapshot}.yaml + $ref: paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml /keyspaces/{keyspace}/tables/{table}/snapshots/{snapshot}: - $ref: paths/keyspaces_{keyspace}_tables_{table}_snapshots_{snapshot}.yaml + $ref: paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml /schema/keyspaces: $ref: paths/schema_keyspaces.yaml /cassandra/schema: $ref: paths/cassandra_schema.yaml /schema/keyspaces/{keyspace}: - $ref: paths/schema_keyspaces_{keyspace}.yaml + $ref: paths/schema_keyspaces_keyspace.yaml /keyspaces/{keyspace}/schema: - $ref: paths/keyspaces_{keyspace}_schema.yaml + $ref: paths/keyspaces_keyspace_schema.yaml /cassandra/ring: $ref: paths/cassandra_ring.yaml /cassandra/ring/keyspaces/{keyspace}: - $ref: paths/cassandra_ring_keyspaces_{keyspace}.yaml + $ref: paths/cassandra_ring_keyspaces_keyspace.yaml /cassandra/stats/stats/connected-clients: $ref: paths/cassandra_stats_stats_connected-clients.yaml /keyspaces/{keyspace}/token-range-replicas: - $ref: paths/keyspaces_{keyspace}_token-range-replicas.yaml + $ref: paths/keyspaces_keyspace_token-range-replicas.yaml /uploads/{uploadId}/keyspaces/{keyspace}/tables/{table}/components/{component}: - $ref: >- - paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_components_{component}.yaml + $ref: "paths/uploads_uploadId_keyspaces_keyspace_tables_table_compon\ + ents_component.yaml" /uploads/{uploadId}/keyspaces/{keyspace}/tables/{table}/import: - $ref: paths/uploads_{uploadId}_keyspaces_{keyspace}_tables_{table}_import.yaml + $ref: paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml /uploads/{uploadId}: - $ref: paths/uploads_{uploadId}.yaml + $ref: paths/uploads_uploadId.yaml /cassandra/gossip: $ref: paths/cassandra_gossip.yaml /time-skew: @@ -83,20 +83,20 @@ paths: /cassandra/settings: $ref: paths/cassandra_settings.yaml /keyspaces/{keyspace}/tables/{table}/restore-jobs: - $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs.yaml + $ref: paths/keyspaces_keyspace_tables_table_restore-jobs.yaml /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}/slices: - $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_slices.yaml + $ref: paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}: - $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}.yaml + $ref: paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}/abort: - $ref: paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_abort.yaml + $ref: paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml /keyspaces/{keyspace}/tables/{table}/restore-jobs/{jobId}/progress: - $ref: >- - paths/keyspaces_{keyspace}_tables_{table}_restore-jobs_{jobId}_progress.yaml + $ref: "paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_prog\ + ress.yaml" /cdc/segments: $ref: paths/cdc_segments.yaml /cdc/segments/{cdcSegment}: - $ref: paths/cdc_segments_{cdcSegment}.yaml + $ref: paths/cdc_segments_cdcSegment.yaml components: securitySchemes: mTLS: From 562a5094985a9b990364e665d88f6b1a17fb7ad6 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 13 Dec 2024 11:52:14 -0800 Subject: [PATCH 03/11] Modifies contributing.md --- .redocly.lint-ignore.yaml | 54 --------------------------------------- CONTRIBUTING.md | 5 ++++ server/build.gradle | 2 -- 3 files changed, 5 insertions(+), 56 deletions(-) delete mode 100644 .redocly.lint-ignore.yaml diff --git a/.redocly.lint-ignore.yaml b/.redocly.lint-ignore.yaml deleted file mode 100644 index 7aee31578..000000000 --- a/.redocly.lint-ignore.yaml +++ /dev/null @@ -1,54 +0,0 @@ -# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API. -# See https://redocly.com/docs/cli/ for more information. -server/src/main/resources/openAPI/sidecarApi.yaml: - info-license: - - '#/info' - operation-4xx-response: - - '#/paths/~1__health/get/responses' - - '#/paths/~1cassandra~1__health/get/responses' - - '#/paths/~1cassandra~1native~1__health/get/responses' - - '#/paths/~1cassandra~1jmx~1__health/get/responses' - - >- - #/paths/~1keyspace~1{keyspace}~1table~1{table}~1snapshots~1{snapshot}~1components~1{component}/get/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}~1components~1{component}/get/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}~1components~1{index}~1{component}/get/responses - - >- - #/paths/~1keyspace~1{keyspace}~1table~1{table}~1snapshots~1{snapshot}/get/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}/get/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}/put/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1snapshots~1{snapshot}/delete/responses - - '#/paths/~1schema~1keyspaces/get/responses' - - '#/paths/~1cassandra~1schema/get/responses' - - '#/paths/~1schema~1keyspaces~1{keyspace}/get/responses' - - '#/paths/~1keyspaces~1{keyspace}~1schema/get/responses' - - '#/paths/~1cassandra~1ring/get/responses' - - '#/paths/~1cassandra~1ring~1keyspaces~1{keyspace}/get/responses' - - '#/paths/~1cassandra~1stats~1stats~1connected-clients/get/responses' - - '#/paths/~1keyspaces~1{keyspace}~1token-range-replicas/get/responses' - - >- - #/paths/~1uploads~1{uploadId}~1keyspaces~1{keyspace}~1tables~1{table}~1components~1{component}/put/responses - - >- - #/paths/~1uploads~1{uploadId}~1keyspaces~1{keyspace}~1tables~1{table}~1import/put/responses - - '#/paths/~1uploads~1{uploadId}/delete/responses' - - '#/paths/~1cassandra~1gossip/get/responses' - - '#/paths/~1time-skew/get/responses' - - '#/paths/~1cassandra~1settings/get/responses' - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs/post/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}~1slices/post/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}/get/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}/patch/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}~1abort/post/responses - - >- - #/paths/~1keyspaces~1{keyspace}~1tables~1{table}~1restore-jobs~1{jobId}~1progress/get/responses - - '#/paths/~1cdc~1segments/get/responses' - - '#/paths/~1cdc~1segments~1{cdcSegment}/get/responses' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 51611b285..9c194cedb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,6 +37,7 @@ We warmly welcome and appreciate contributions from the community. * [Future Composition](#future-composition) * [Failure Handling](#failure-handling) * [Cassandra Adapters](#cassandra-adapters) + * [REST APIs](#rest-apis) * [Source Code Style](#source-code-style) ## How to Contribute @@ -336,6 +337,10 @@ When adding shims, implement the minimum necessary changes in the new package an For example, if `base`'s minimum version is moved to 5.0, a Cassandra40 adapter package/subproject should be added, with a minimum version of 4.0.0. Within that project, the classes should all be named `Cassandra40*`, so `Cassandra40Adapter`, `Cassandra40Factory`, etc. +### REST APIs +The project maintains an Open API documentation of all the provided REST APIs, located in `server/src/main/resources/openAPI`. +When an API is modified or updated, this documentation needs to be maintained accordingly. + ## Source Code Style The project provides an diff --git a/server/build.gradle b/server/build.gradle index 68522755b..b3f01dde8 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -262,11 +262,9 @@ openApiValidate { inputSpec.set("$rootDir/server/src/main/resources/openAPI/sidecarApi.yaml") recommend.set(true) } - openApiGenerate { generatorName.set("html2") inputSpec.set("$rootDir/server/src/main/resources/openAPI/sidecarApi.yaml") outputDir.set("$buildDir/apiDocs") } - compileJava.dependsOn tasks.openApiGenerate \ No newline at end of file From 2497d53208d4e38807464bee6806cae9d147a5a4 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Wed, 18 Dec 2024 11:04:03 -0800 Subject: [PATCH 04/11] Updates version and summaries --- server/build.gradle | 2 +- .../src/main/resources/openAPI/paths/__health.yaml | 2 +- .../resources/openAPI/paths/cassandra___health.yaml | 2 +- .../resources/openAPI/paths/cassandra_gossip.yaml | 2 +- .../openAPI/paths/cassandra_jmx___health.yaml | 2 +- .../openAPI/paths/cassandra_native___health.yaml | 2 +- .../main/resources/openAPI/paths/cassandra_ring.yaml | 2 +- .../paths/cassandra_ring_keyspaces_keyspace.yaml | 2 +- .../resources/openAPI/paths/cassandra_schema.yaml | 4 ++-- .../resources/openAPI/paths/cassandra_settings.yaml | 2 +- .../cassandra_stats_stats_connected-clients.yaml | 2 +- .../main/resources/openAPI/paths/cdc_segments.yaml | 2 +- .../openAPI/paths/cdc_segments_cdcSegment.yaml | 4 ++-- ...pace_keyspace_table_table_snapshots_snapshot.yaml | 4 ++-- ...able_snapshots_snapshot_components_component.yaml | 4 ++-- .../openAPI/paths/keyspaces_keyspace_schema.yaml | 4 ++-- ...keyspaces_keyspace_tables_table_restore-jobs.yaml | 2 +- ...ces_keyspace_tables_table_restore-jobs_jobId.yaml | 4 ++-- ...yspace_tables_table_restore-jobs_jobId_abort.yaml | 2 +- ...ace_tables_table_restore-jobs_jobId_progress.yaml | 4 ++-- ...space_tables_table_restore-jobs_jobId_slices.yaml | 4 ++-- ...ces_keyspace_tables_table_snapshots_snapshot.yaml | 12 ++++++------ ...able_snapshots_snapshot_components_component.yaml | 2 +- ...napshots_snapshot_components_index_component.yaml | 4 ++-- .../keyspaces_keyspace_token-range-replicas.yaml | 2 +- .../resources/openAPI/paths/schema_keyspaces.yaml | 4 ++-- .../openAPI/paths/schema_keyspaces_keyspace.yaml | 4 ++-- .../src/main/resources/openAPI/paths/time-skew.yaml | 4 ++-- .../resources/openAPI/paths/uploads_uploadId.yaml | 4 ++-- ...s_keyspace_tables_table_components_component.yaml | 4 ++-- ...oadId_keyspaces_keyspace_tables_table_import.yaml | 4 ++-- 31 files changed, 51 insertions(+), 51 deletions(-) diff --git a/server/build.gradle b/server/build.gradle index b3f01dde8..742acbc66 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -31,7 +31,7 @@ plugins { // and produces a docker image id('com.google.cloud.tools.jib') version '3.4.4' // openAPI - id "org.openapi.generator" version "6.6.0" + id "org.openapi.generator" version "7.10.0" } sourceCompatibility = JavaVersion.VERSION_11 diff --git a/server/src/main/resources/openAPI/paths/__health.yaml b/server/src/main/resources/openAPI/paths/__health.yaml index 68c6dfbed..00df5f5aa 100644 --- a/server/src/main/resources/openAPI/paths/__health.yaml +++ b/server/src/main/resources/openAPI/paths/__health.yaml @@ -3,7 +3,7 @@ get: - healthchecks operationId: healthcheck description: Check health - summary: Check health + summary: Endpoint used to perform health checks against a Sidecar instance security: [] responses: '200': diff --git a/server/src/main/resources/openAPI/paths/cassandra___health.yaml b/server/src/main/resources/openAPI/paths/cassandra___health.yaml index 7802817bc..e418fd13e 100644 --- a/server/src/main/resources/openAPI/paths/cassandra___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra___health.yaml @@ -3,7 +3,7 @@ get: - healthchecks operationId: cassandraHealthcheck description: Check health - summary: Check health + summary: Endpoint used to perform health checks to a Cassandra instance security: [] responses: '200': diff --git a/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml b/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml index bd60c9c5b..9bb37b19a 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml @@ -3,7 +3,7 @@ get: - gossip operationId: gossipInfo description: Get Gossip info - summary: Get Gossip info + summary: Gets all the gossip protocol related info security: - mTLS: [] responses: diff --git a/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml index 9f2b26b69..80465a904 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml @@ -3,7 +3,7 @@ get: - healthchecks operationId: jmxHealthcheck description: Check health - summary: Check health + summary: Endpoint used to perform health checks to for JMX connection security: [] responses: '200': diff --git a/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml index 78a9f6e3b..1a5a72f11 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml @@ -3,7 +3,7 @@ get: - healthchecks operationId: cassandraNativeHealthcheck description: Check health - summary: Check health + summary: Endpoint used to perform health checks to for native connection security: [] responses: '200': diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring.yaml index d5b1b9665..5617e25cd 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_ring.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_ring.yaml @@ -3,7 +3,7 @@ get: - ring operationId: getRing description: Gets the ring status - summary: Gets the ring status + summary: This endpoint retrieves the information related to ring security: - mTLS: [] responses: diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml index 34d43caf1..8e602ef5a 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml @@ -3,7 +3,7 @@ get: - ring operationId: getRingPerKeyspace description: Gets the ring status for a keyspace - summary: Gets the ring status for a keyspace + summary: This endpoint retrieves the information related to ring for a given keyspace security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/cassandra_schema.yaml b/server/src/main/resources/openAPI/paths/cassandra_schema.yaml index 6beb85d35..0f1e65ad1 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_schema.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_schema.yaml @@ -2,8 +2,8 @@ get: tags: - keyspaces operationId: listAllKeyspaces - description: Gets all the keyspaces from the database. - summary: Gets all the keyspaces from the database. + description: Gets all the keyspaces from the database + summary: Endpoint to retrieve the schemas of a database, in all of the user keyspaces security: - mTLS: [] responses: diff --git a/server/src/main/resources/openAPI/paths/cassandra_settings.yaml b/server/src/main/resources/openAPI/paths/cassandra_settings.yaml index e7c22d4f9..a0d4fe202 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_settings.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_settings.yaml @@ -3,7 +3,7 @@ get: - settings operationId: nodeSettings description: Get the settings of a node - summary: Get the settings of a node + summary: Endpoint used to retrieve the current settings of a Cassandra node security: - mTLS: [] responses: diff --git a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml index d0c987c13..0f6d7aa3e 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml @@ -3,7 +3,7 @@ get: - stats operationId: getClientStats description: Gets stats of connected clients - summary: Gets stats of connected clients + summary: Endpoint to retrieve the information related to connected clients to the database security: - mTLS: [] responses: diff --git a/server/src/main/resources/openAPI/paths/cdc_segments.yaml b/server/src/main/resources/openAPI/paths/cdc_segments.yaml index 97449a77e..dd414feb0 100644 --- a/server/src/main/resources/openAPI/paths/cdc_segments.yaml +++ b/server/src/main/resources/openAPI/paths/cdc_segments.yaml @@ -2,7 +2,7 @@ get: tags: - cdc operationId: listCdcSegment - description: Endpoint used to list the pending cdc segments + description: List all the cdc segments summary: Endpoint used to list the pending cdc segments security: - mTLS: [] diff --git a/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml b/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml index a2d171278..e9ce9d230 100644 --- a/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml +++ b/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml @@ -2,8 +2,8 @@ get: tags: - cdc operationId: streamCdcSegment - description: Endpoint get a cdc segment - summary: Endpoint get a cdc segment + description: Get CDC Segment + summary: Endpoint get a specific cdc segment information security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml index a843f899b..dbc1366e8 100644 --- a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml +++ b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml @@ -2,8 +2,8 @@ get: tags: - snapshots operationId: deprecatedGetSnapshots - description: Deprecated endpoint to get the info of a snapshot. - summary: Deprecated endpoint to get the info of a snapshot. + description: Get snapshot information + summary: Deprecated endpoint to get the information of a given snapshot security: - mTLS: [] deprecated: true diff --git a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml index 88a839ec3..de73773b9 100644 --- a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml +++ b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml @@ -2,8 +2,8 @@ get: tags: - components operationId: deprecatedGetComponent - description: Deprecated endpoint to get the component from a snapshot. - summary: Deprecated endpoint to get the component from a snapshot. + description: Get the component from a snapshot + summary: Deprecated endpoint to get the component from a given snapshot security: - mTLS: [] deprecated: true diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml index e07967581..5799488a8 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml @@ -2,8 +2,8 @@ get: tags: - keyspaces operationId: getAKeyspaces - description: Gets a keyspace schema. - summary: Gets a keyspace schema. + description: Gets Schema + summary: Gets the schemas from a keyspace security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml index 4a80578e7..8cff9d85a 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml @@ -2,7 +2,7 @@ post: tags: - jobs operationId: createRestoreJob - description: Endpoint used to create a restore job + description: Create Restore Job summary: Endpoint used to create a restore job security: - mTLS: [] diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml index 04574a159..5267374a4 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml @@ -2,8 +2,8 @@ get: tags: - jobs operationId: getRestoreJob - description: Endpoint used to create a restore job info - summary: Endpoint used to create a restore job info + description: Get restore job info + summary: Endpoint used to get a restore job information security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml index c403017d6..aa5abb994 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml @@ -2,7 +2,7 @@ post: tags: - jobs operationId: abortRestoreJob - description: Endpoint used to abort a restore job + description: Abort restore job summary: Endpoint used to abort a restore job security: - mTLS: [] diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml index ae61dfec8..ac1933e94 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml @@ -2,8 +2,8 @@ get: tags: - jobs operationId: getRestoreJobProgress - description: Endpoint used to get a restore job progress info - summary: Endpoint used to get a restore job progress info + description: Get Restore Job Progress + summary: Endpoint used to get a restore job progress information security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml index 34a35c696..05eda8e2e 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml @@ -1,8 +1,8 @@ post: tags: - jobs - operationId: getRestoreJobSlices - description: Endpoint used to create a restore job slice + operationId: createRestoreJobSlice + description: Create Job Slice summary: Endpoint used to create a restore job slice security: - mTLS: [] diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml index 57d0c49ef..cd0dbfa56 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml @@ -1,9 +1,9 @@ get: tags: - snapshots - operationId: getSnapshots - description: Endpoint to get the info of a snapshot. - summary: Endpoint to get the info of a snapshot. + operationId: getSnapshot + description: Get Snapshot Info + summary: Endpoint to get the information of a snapshot security: - mTLS: [] parameters: @@ -21,8 +21,8 @@ delete: tags: - snapshots operationId: deleteSnapshot - description: Endpoint to delete a snapshot. - summary: Endpoint to delete a snapshot. + description: Delete a snapshot + summary: Endpoint to delete a snapshot security: - mTLS: [] parameters: @@ -37,7 +37,7 @@ put: - snapshots operationId: createSnapshot description: Creates a snapshot - summary: Creates a snapshot + summary: Endpoint to creates a snapshot security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml index b045059a1..3b01555d7 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml @@ -2,7 +2,7 @@ get: tags: - components operationId: getComponent - description: Endpoint to get the component from a snapshot. + description: Get Component summary: Endpoint to get the component from a snapshot. security: - mTLS: [] diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml index 7769f4993..3c8b490d0 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml @@ -2,8 +2,8 @@ get: tags: - components operationId: getComponentFromIndex - description: Endpoint to get the component from a snapshot using a specific index. - summary: Endpoint to get the component from a snapshot using a specific index. + description: Get Component From Index + summary: Endpoint to get the component from a snapshot using a specific index security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml index 13e022d4a..8699032f9 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml @@ -2,7 +2,7 @@ get: tags: - tokenrange operationId: getTokenRangeReplica - description: Gets the token range replicas for a given keyspace + description: Get Token Range Replica summary: Gets the token range replicas for a given keyspace security: - mTLS: [] diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml index e794a887b..ff5e9bacd 100644 --- a/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml +++ b/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml @@ -2,8 +2,8 @@ get: tags: - keyspaces operationId: deprecatedListAllKeyspaces - description: Gets all the keyspaces from the database. - summary: Gets all the keyspaces from the database. + description: Get All Keyspaces + summary: Endpoint to gets all the keyspaces from the database security: - mTLS: [] deprecated: true diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml index 4927f7cb3..b895744bd 100644 --- a/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml +++ b/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml @@ -2,8 +2,8 @@ get: tags: - keyspaces operationId: deprecatedGetAKeyspaces - description: Gets a keyspace schema. - summary: Gets a keyspace schema. + description: Get Keyspace + summary: Endpoint to get a keyspace schema security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/time-skew.yaml b/server/src/main/resources/openAPI/paths/time-skew.yaml index df4bff4e0..d924b66d9 100644 --- a/server/src/main/resources/openAPI/paths/time-skew.yaml +++ b/server/src/main/resources/openAPI/paths/time-skew.yaml @@ -2,8 +2,8 @@ get: tags: - gossip operationId: timeSkew - description: Get Gossip info - summary: Get Gossip info + description: Get Time Skew + summary: Endpoint to get the time skey security: - mTLS: [] responses: diff --git a/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml index f12e62e43..a972bd024 100644 --- a/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml +++ b/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml @@ -2,8 +2,8 @@ delete: tags: - sstables operationId: ssTableCleanup - description: Clean up an SSTable - summary: Clean up an SSTable + description: Cleanup SSTable + summary: Endpoint to start the clean up of an SSTable security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml index 4236c2d42..73e907676 100644 --- a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml +++ b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml @@ -2,8 +2,8 @@ put: tags: - sstables operationId: uploadSSTable - description: Upload an SSTable - summary: Upload an SSTable + description: Upload SSTable + summary: Endpoint to upload an SSTable security: - mTLS: [] parameters: diff --git a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml index bc5cb03e5..012502f59 100644 --- a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml +++ b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml @@ -2,8 +2,8 @@ put: tags: - sstables operationId: importSSTable - description: Import an SSTable - summary: Import an SSTable + description: Import SSTable + summary: Endpoint to import an SSTable security: - mTLS: [] parameters: From ea0a6a09b1822d1de778ef04e7be449124a1d0b4 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Wed, 18 Dec 2024 11:25:50 -0800 Subject: [PATCH 05/11] Updates patchRestoreJob summary and description --- .../keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml index 5267374a4..4b34075dc 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml @@ -21,8 +21,8 @@ patch: tags: - jobs operationId: patchRestoreJob - description: Endpoint used to patch a restore job info - summary: Endpoint used to patch a restore job info + description: Modify Restore Job + summary: Endpoint used to modify a restore job info security: - mTLS: [] parameters: From 25156cd29f1fa94592f42aab2bee56cd3e37adee Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 31 Jan 2025 11:29:06 -0800 Subject: [PATCH 06/11] Expand the contributing section --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c194cedb..3ba8adce9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -339,7 +339,18 @@ Within that project, the classes should all be named `Cassandra40*`, so `Cassand ### REST APIs The project maintains an Open API documentation of all the provided REST APIs, located in `server/src/main/resources/openAPI`. -When an API is modified or updated, this documentation needs to be maintained accordingly. +When an API is modified or updated, this documentation needs to be maintained accordingly. For that, please take a look at the folder structure +for the openAPI specification. The main file is called `sidecarApi.yaml`. There, all the endpoints are referenced. Let's take the health endpoint +as an example: +```yaml +paths: + /__health: + $ref: paths/__health.yaml +``` + +That references the definition of the health endpoint, which can be found on the `paths` folder. On those references, we can find further references +to their specific object schemas (which can be found under the `components/schemas` folder). For any common or shared parameters, please use +the `components/parameters folder`. ## Source Code Style From 9553680bd5d2dd8a676aff2db4db7d31bf8c5dac Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 31 Jan 2025 11:43:22 -0800 Subject: [PATCH 07/11] Adds Cassandra gossip health endpoint --- .../openAPI/paths/cassandra_gossip___health.yaml | 14 ++++++++++++++ server/src/main/resources/openAPI/sidecarApi.yaml | 2 ++ 2 files changed, 16 insertions(+) create mode 100644 server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml diff --git a/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml new file mode 100644 index 000000000..5c73547ab --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml @@ -0,0 +1,14 @@ +get: + tags: + - healthchecks + operationId: cassandraGossipHealthcheck + description: Check Gossip health + summary: Endpoint used to perform gossip health checks to a Cassandra instance + security: [] + responses: + '200': + description: Healthy + content: + application/json: + schema: + $ref: ../components/schemas/healthCheckResponse.yaml diff --git a/server/src/main/resources/openAPI/sidecarApi.yaml b/server/src/main/resources/openAPI/sidecarApi.yaml index 17e223726..418125273 100644 --- a/server/src/main/resources/openAPI/sidecarApi.yaml +++ b/server/src/main/resources/openAPI/sidecarApi.yaml @@ -36,6 +36,8 @@ paths: $ref: paths/__health.yaml /cassandra/__health: $ref: paths/cassandra___health.yaml + /cassandra/gossip/__health: + $ref: paths/cassandra_gossip___health.yaml /cassandra/native/__health: $ref: paths/cassandra_native___health.yaml /cassandra/jmx/__health: From ac60b84d6ba8e1a1eef6a78b95f10ab119cf5d69 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 31 Jan 2025 11:56:59 -0800 Subject: [PATCH 08/11] Adds stream stats endpoint --- .../schemas/streamStatsResponse.yaml | 8 +++++ .../schemas/streamsProgressStats.yaml | 34 +++++++++++++++++++ ...ssandra_stats_stats_connected-clients.yaml | 2 +- .../paths/cassandra_stats_streams.yaml | 15 ++++++++ .../main/resources/openAPI/sidecarApi.yaml | 4 ++- 5 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml create mode 100644 server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml create mode 100644 server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml b/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml new file mode 100644 index 000000000..254518e14 --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml @@ -0,0 +1,8 @@ +type: object +properties: + operationMode: + type: string + description: The operation Mode + example: Mode + streamsProgressStats: + $ref: ./streamsProgressStats.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml b/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml new file mode 100644 index 000000000..21b6769db --- /dev/null +++ b/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml @@ -0,0 +1,34 @@ +type: object +properties: + totalFilesToReceive: + type: number + description: The amount of files to be received + example: 1000 + totalFilesReceived: + type: number + description: The amount of files that have been received + example: 1000 + totalBytesToReceive: + type: number + description: The amount of bytes to be received + example: 1000 + totalBytesReceived: + type: number + description: The amount of bytes that have been received + example: 1000 + totalFilesToSend: + type: number + description: The amount of files to be sent + example: 1000 + totalFilesSent: + type: number + description: The amount of files that have been sent + example: 1000 + totalBytesToSend: + type: number + description: The amount of bytes to be sent + example: 1000 + totalBytesSent: + type: number + description: The amount of bytes that have been sent + example: 1000 diff --git a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml index 0f6d7aa3e..41e3f35c6 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml @@ -8,7 +8,7 @@ get: - mTLS: [] responses: '200': - description: Ring status + description: Connected clients stats content: application/json: schema: diff --git a/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml b/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml new file mode 100644 index 000000000..9ee29c37c --- /dev/null +++ b/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml @@ -0,0 +1,15 @@ +get: + tags: + - stats + operationId: getStreamStats + description: Gets stats of streams + summary: Endpoint to retrieve the information related to streams + security: + - mTLS: [] + responses: + '200': + description: Stream stats + content: + application/json: + schema: + $ref: "../components/schemas/streamStatsResponse.yaml" diff --git a/server/src/main/resources/openAPI/sidecarApi.yaml b/server/src/main/resources/openAPI/sidecarApi.yaml index 418125273..50e18a119 100644 --- a/server/src/main/resources/openAPI/sidecarApi.yaml +++ b/server/src/main/resources/openAPI/sidecarApi.yaml @@ -67,8 +67,10 @@ paths: $ref: paths/cassandra_ring.yaml /cassandra/ring/keyspaces/{keyspace}: $ref: paths/cassandra_ring_keyspaces_keyspace.yaml - /cassandra/stats/stats/connected-clients: + /cassandra/stats/connected-clients: $ref: paths/cassandra_stats_stats_connected-clients.yaml + /cassandra/stats/streams: + $ref: paths/cassandra_stats_streams.yaml /keyspaces/{keyspace}/token-range-replicas: $ref: paths/keyspaces_keyspace_token-range-replicas.yaml /uploads/{uploadId}/keyspaces/{keyspace}/tables/{table}/components/{component}: From b8d4143d50101cebf7cd39f47acf9a9646233292 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 31 Jan 2025 13:29:08 -0800 Subject: [PATCH 09/11] Adds licenses --- .../components/parameters/cdcSegment.yaml | 17 +++++++++++++++++ .../components/parameters/component.yaml | 17 +++++++++++++++++ .../openAPI/components/parameters/index.yaml | 17 +++++++++++++++++ .../openAPI/components/parameters/jobId.yaml | 17 +++++++++++++++++ .../openAPI/components/parameters/keyspace.yaml | 17 +++++++++++++++++ .../openAPI/components/parameters/snapshot.yaml | 17 +++++++++++++++++ .../openAPI/components/parameters/table.yaml | 17 +++++++++++++++++ .../openAPI/components/parameters/uploadId.yaml | 17 +++++++++++++++++ .../components/schemas/cdcSegmentInfo.yaml | 17 +++++++++++++++++ .../components/schemas/cdcSegmentsResponse.yaml | 17 +++++++++++++++++ .../schemas/clientConnectionEntry.yaml | 17 +++++++++++++++++ .../schemas/connectedClientStatsResponse.yaml | 17 +++++++++++++++++ .../components/schemas/consistencyConfig.yaml | 17 +++++++++++++++++ .../schemas/createRestoreJobRequest.yaml | 17 +++++++++++++++++ .../schemas/createRestoreJobResponse.yaml | 17 +++++++++++++++++ .../components/schemas/createSliceRequest.yaml | 17 +++++++++++++++++ .../schemas/createSnapshotRequest.yaml | 17 +++++++++++++++++ .../components/schemas/healthCheckResponse.yaml | 17 +++++++++++++++++ .../components/schemas/nodeSettings.yaml | 17 +++++++++++++++++ .../components/schemas/qualifiedTableName.yaml | 17 +++++++++++++++++ .../openAPI/components/schemas/replicaInfo.yaml | 17 +++++++++++++++++ .../components/schemas/replicaInfoResponse.yaml | 17 +++++++++++++++++ .../schemas/restoreJobProgressResponse.yaml | 17 +++++++++++++++++ .../components/schemas/restoreJobSecrets.yaml | 17 +++++++++++++++++ .../components/schemas/restoreJobSummary.yaml | 17 +++++++++++++++++ .../components/schemas/restoredRange.yaml | 17 +++++++++++++++++ .../openAPI/components/schemas/ringEntry.yaml | 17 +++++++++++++++++ .../components/schemas/ringEntryList.yaml | 17 +++++++++++++++++ .../components/schemas/schemaResponse.yaml | 17 +++++++++++++++++ .../components/schemas/snapshotFileInfo.yaml | 17 +++++++++++++++++ .../schemas/snapshotFileInfoList.yaml | 17 +++++++++++++++++ .../schemas/ssTableImportRequest.yaml | 17 +++++++++++++++++ .../schemas/ssTableImportResponse.yaml | 17 +++++++++++++++++ .../schemas/ssTableUploadResponse.yaml | 17 +++++++++++++++++ .../components/schemas/storageCredentials.yaml | 17 +++++++++++++++++ .../components/schemas/streamStatsResponse.yaml | 17 +++++++++++++++++ .../schemas/streamsProgressStats.yaml | 17 +++++++++++++++++ .../components/schemas/timeSkewResponse.yaml | 17 +++++++++++++++++ .../schemas/updateRestoreJobRequest.yaml | 17 +++++++++++++++++ .../main/resources/openAPI/paths/__health.yaml | 17 +++++++++++++++++ .../openAPI/paths/cassandra___health.yaml | 17 +++++++++++++++++ .../openAPI/paths/cassandra_gossip.yaml | 17 +++++++++++++++++ .../paths/cassandra_gossip___health.yaml | 17 +++++++++++++++++ .../openAPI/paths/cassandra_jmx___health.yaml | 17 +++++++++++++++++ .../paths/cassandra_native___health.yaml | 17 +++++++++++++++++ .../resources/openAPI/paths/cassandra_ring.yaml | 17 +++++++++++++++++ .../cassandra_ring_keyspaces_keyspace.yaml | 17 +++++++++++++++++ .../openAPI/paths/cassandra_schema.yaml | 17 +++++++++++++++++ .../openAPI/paths/cassandra_settings.yaml | 17 +++++++++++++++++ ...cassandra_stats_stats_connected-clients.yaml | 17 +++++++++++++++++ .../openAPI/paths/cassandra_stats_streams.yaml | 17 +++++++++++++++++ .../resources/openAPI/paths/cdc_segments.yaml | 17 +++++++++++++++++ .../openAPI/paths/cdc_segments_cdcSegment.yaml | 17 +++++++++++++++++ ...keyspace_table_table_snapshots_snapshot.yaml | 17 +++++++++++++++++ ...snapshots_snapshot_components_component.yaml | 17 +++++++++++++++++ .../paths/keyspaces_keyspace_schema.yaml | 17 +++++++++++++++++ ...aces_keyspace_tables_table_restore-jobs.yaml | 17 +++++++++++++++++ ...eyspace_tables_table_restore-jobs_jobId.yaml | 17 +++++++++++++++++ ...e_tables_table_restore-jobs_jobId_abort.yaml | 17 +++++++++++++++++ ...ables_table_restore-jobs_jobId_progress.yaml | 17 +++++++++++++++++ ..._tables_table_restore-jobs_jobId_slices.yaml | 17 +++++++++++++++++ ...eyspace_tables_table_snapshots_snapshot.yaml | 17 +++++++++++++++++ ...snapshots_snapshot_components_component.yaml | 17 +++++++++++++++++ ...ots_snapshot_components_index_component.yaml | 17 +++++++++++++++++ ...keyspaces_keyspace_token-range-replicas.yaml | 17 +++++++++++++++++ .../openAPI/paths/schema_keyspaces.yaml | 17 +++++++++++++++++ .../paths/schema_keyspaces_keyspace.yaml | 17 +++++++++++++++++ .../main/resources/openAPI/paths/time-skew.yaml | 17 +++++++++++++++++ .../openAPI/paths/uploads_uploadId.yaml | 17 +++++++++++++++++ ...space_tables_table_components_component.yaml | 17 +++++++++++++++++ ..._keyspaces_keyspace_tables_table_import.yaml | 17 +++++++++++++++++ .../src/main/resources/openAPI/sidecarApi.yaml | 17 +++++++++++++++++ 72 files changed, 1224 insertions(+) diff --git a/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml b/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml index b57585c74..b170064f3 100644 --- a/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml +++ b/server/src/main/resources/openAPI/components/parameters/cdcSegment.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: cdcSegment required: true diff --git a/server/src/main/resources/openAPI/components/parameters/component.yaml b/server/src/main/resources/openAPI/components/parameters/component.yaml index 4e3b40f89..b92e1dee6 100644 --- a/server/src/main/resources/openAPI/components/parameters/component.yaml +++ b/server/src/main/resources/openAPI/components/parameters/component.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: component required: true diff --git a/server/src/main/resources/openAPI/components/parameters/index.yaml b/server/src/main/resources/openAPI/components/parameters/index.yaml index 48fb11d58..607edc2c7 100644 --- a/server/src/main/resources/openAPI/components/parameters/index.yaml +++ b/server/src/main/resources/openAPI/components/parameters/index.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: index required: true diff --git a/server/src/main/resources/openAPI/components/parameters/jobId.yaml b/server/src/main/resources/openAPI/components/parameters/jobId.yaml index 55ecd90d2..b6f2480a6 100644 --- a/server/src/main/resources/openAPI/components/parameters/jobId.yaml +++ b/server/src/main/resources/openAPI/components/parameters/jobId.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: jobId required: true diff --git a/server/src/main/resources/openAPI/components/parameters/keyspace.yaml b/server/src/main/resources/openAPI/components/parameters/keyspace.yaml index 17c462e08..a530c1d2f 100644 --- a/server/src/main/resources/openAPI/components/parameters/keyspace.yaml +++ b/server/src/main/resources/openAPI/components/parameters/keyspace.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path required: true name: keyspace diff --git a/server/src/main/resources/openAPI/components/parameters/snapshot.yaml b/server/src/main/resources/openAPI/components/parameters/snapshot.yaml index a8a82a55b..531cc9fdf 100644 --- a/server/src/main/resources/openAPI/components/parameters/snapshot.yaml +++ b/server/src/main/resources/openAPI/components/parameters/snapshot.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: snapshot required: true diff --git a/server/src/main/resources/openAPI/components/parameters/table.yaml b/server/src/main/resources/openAPI/components/parameters/table.yaml index 8a730e72e..d68c800d4 100644 --- a/server/src/main/resources/openAPI/components/parameters/table.yaml +++ b/server/src/main/resources/openAPI/components/parameters/table.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: table required: true diff --git a/server/src/main/resources/openAPI/components/parameters/uploadId.yaml b/server/src/main/resources/openAPI/components/parameters/uploadId.yaml index c3d2c3990..adc611cc8 100644 --- a/server/src/main/resources/openAPI/components/parameters/uploadId.yaml +++ b/server/src/main/resources/openAPI/components/parameters/uploadId.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + in: path name: uploadId required: true diff --git a/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml b/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml index a60eafc57..d10769ed1 100644 --- a/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml +++ b/server/src/main/resources/openAPI/components/schemas/cdcSegmentInfo.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object description: The information of a cdc segment properties: diff --git a/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml b/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml index 49895543e..d5803cc76 100644 --- a/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/cdcSegmentsResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object description: The response for list cdc segments call properties: diff --git a/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml b/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml index 5eebab52b..296b7573a 100644 --- a/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml +++ b/server/src/main/resources/openAPI/components/schemas/clientConnectionEntry.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object description: Details of a client connection properties: diff --git a/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml b/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml index 421187cab..679f88168 100644 --- a/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/connectedClientStatsResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: clientConnections: diff --git a/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml b/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml index cd2ecf5d9..2b4ad910f 100644 --- a/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml +++ b/server/src/main/resources/openAPI/components/schemas/consistencyConfig.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: consistencyLevel: diff --git a/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml b/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml index d759056a3..099487216 100644 --- a/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml +++ b/server/src/main/resources/openAPI/components/schemas/createRestoreJobRequest.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: jobId: diff --git a/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml b/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml index e64a0c6c1..f05bb792b 100644 --- a/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/createRestoreJobResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: jobId: diff --git a/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml b/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml index e73e87406..ab28f276b 100644 --- a/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml +++ b/server/src/main/resources/openAPI/components/schemas/createSliceRequest.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: sliceId: diff --git a/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml b/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml index d3e808a42..175a519e3 100644 --- a/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml +++ b/server/src/main/resources/openAPI/components/schemas/createSnapshotRequest.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: snapshotName: diff --git a/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml b/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml index 9fb254ff0..dd80e2c3d 100644 --- a/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/healthCheckResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: status: diff --git a/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml b/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml index c8ef0055d..12b9365f0 100644 --- a/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml +++ b/server/src/main/resources/openAPI/components/schemas/nodeSettings.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: releaseVersion: diff --git a/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml b/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml index d53364c2f..a30d0bb2f 100644 --- a/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml +++ b/server/src/main/resources/openAPI/components/schemas/qualifiedTableName.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: keyspace: diff --git a/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml b/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml index 891766bb8..5a11d9bf3 100644 --- a/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml +++ b/server/src/main/resources/openAPI/components/schemas/replicaInfo.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: start: diff --git a/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml b/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml index da36a94ec..b61e422dc 100644 --- a/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/replicaInfoResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: readReplicas: diff --git a/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml b/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml index 61a78791f..ac4494278 100644 --- a/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/restoreJobProgressResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: message: diff --git a/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml b/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml index e849a482b..1109a75a0 100644 --- a/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml +++ b/server/src/main/resources/openAPI/components/schemas/restoreJobSecrets.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: writeCredentials: diff --git a/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml b/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml index c44b51116..db79f45a2 100644 --- a/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml +++ b/server/src/main/resources/openAPI/components/schemas/restoreJobSummary.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: createdAt: diff --git a/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml b/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml index ffbab4092..1bf6d6202 100644 --- a/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml +++ b/server/src/main/resources/openAPI/components/schemas/restoredRange.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: sliceId: diff --git a/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml b/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml index c07460ae4..626a346de 100644 --- a/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml +++ b/server/src/main/resources/openAPI/components/schemas/ringEntry.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: datacenter: diff --git a/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml b/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml index c6a7377c1..8841db486 100644 --- a/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml +++ b/server/src/main/resources/openAPI/components/schemas/ringEntryList.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: array items: $ref: ./ringEntry.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml b/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml index 4bb9b84a8..e8414728a 100644 --- a/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/schemaResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: keyspace: diff --git a/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml index c01c80a46..c26abb538 100644 --- a/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml +++ b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfo.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: size: diff --git a/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml index cecca48c0..a0709b15a 100644 --- a/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml +++ b/server/src/main/resources/openAPI/components/schemas/snapshotFileInfoList.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: array items: $ref: ./snapshotFileInfo.yaml diff --git a/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml b/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml index b46701345..df1d1ac41 100644 --- a/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml +++ b/server/src/main/resources/openAPI/components/schemas/ssTableImportRequest.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: resetLevel: diff --git a/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml b/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml index 313ce2563..2a13fa599 100644 --- a/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/ssTableImportResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: success: diff --git a/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml b/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml index a9c5a2d2d..b369a201b 100644 --- a/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/ssTableUploadResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: uploadId: diff --git a/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml b/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml index 0afceeb5f..b3cd23056 100644 --- a/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml +++ b/server/src/main/resources/openAPI/components/schemas/storageCredentials.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: accessKeyId: diff --git a/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml b/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml index 254518e14..a78d2b247 100644 --- a/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/streamStatsResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: operationMode: diff --git a/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml b/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml index 21b6769db..5044a48cf 100644 --- a/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml +++ b/server/src/main/resources/openAPI/components/schemas/streamsProgressStats.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: totalFilesToReceive: diff --git a/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml b/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml index 2bee16bfc..bb462bdb8 100644 --- a/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml +++ b/server/src/main/resources/openAPI/components/schemas/timeSkewResponse.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: currentTime: diff --git a/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml b/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml index 62eea1b61..075f358f4 100644 --- a/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml +++ b/server/src/main/resources/openAPI/components/schemas/updateRestoreJobRequest.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + type: object properties: jobAgent: diff --git a/server/src/main/resources/openAPI/paths/__health.yaml b/server/src/main/resources/openAPI/paths/__health.yaml index 00df5f5aa..5dd24fe1a 100644 --- a/server/src/main/resources/openAPI/paths/__health.yaml +++ b/server/src/main/resources/openAPI/paths/__health.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - healthchecks diff --git a/server/src/main/resources/openAPI/paths/cassandra___health.yaml b/server/src/main/resources/openAPI/paths/cassandra___health.yaml index e418fd13e..aaa3e61ed 100644 --- a/server/src/main/resources/openAPI/paths/cassandra___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra___health.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - healthchecks diff --git a/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml b/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml index 9bb37b19a..b24db018b 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_gossip.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - gossip diff --git a/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml index 5c73547ab..56376c2bb 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - healthchecks diff --git a/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml index 80465a904..fe465eeab 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_jmx___health.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - healthchecks diff --git a/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml index 1a5a72f11..61224455e 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_native___health.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - healthchecks diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring.yaml index 5617e25cd..282651901 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_ring.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_ring.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - ring diff --git a/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml index 8e602ef5a..dfe73ef83 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_ring_keyspaces_keyspace.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - ring diff --git a/server/src/main/resources/openAPI/paths/cassandra_schema.yaml b/server/src/main/resources/openAPI/paths/cassandra_schema.yaml index 0f1e65ad1..fc1684bff 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_schema.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_schema.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - keyspaces diff --git a/server/src/main/resources/openAPI/paths/cassandra_settings.yaml b/server/src/main/resources/openAPI/paths/cassandra_settings.yaml index a0d4fe202..cbc6e74c2 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_settings.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_settings.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - settings diff --git a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml index 41e3f35c6..e08eef554 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_stats_stats_connected-clients.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - stats diff --git a/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml b/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml index 9ee29c37c..548e8fc29 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_stats_streams.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - stats diff --git a/server/src/main/resources/openAPI/paths/cdc_segments.yaml b/server/src/main/resources/openAPI/paths/cdc_segments.yaml index dd414feb0..d824d3054 100644 --- a/server/src/main/resources/openAPI/paths/cdc_segments.yaml +++ b/server/src/main/resources/openAPI/paths/cdc_segments.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - cdc diff --git a/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml b/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml index e9ce9d230..84165dd5b 100644 --- a/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml +++ b/server/src/main/resources/openAPI/paths/cdc_segments_cdcSegment.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - cdc diff --git a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml index dbc1366e8..9fb25972b 100644 --- a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml +++ b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - snapshots diff --git a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml index de73773b9..318bb122a 100644 --- a/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml +++ b/server/src/main/resources/openAPI/paths/keyspace_keyspace_table_table_snapshots_snapshot_components_component.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - components diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml index 5799488a8..119dd59d0 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_schema.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - keyspaces diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml index 8cff9d85a..e8ae62bdd 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + post: tags: - jobs diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml index 4b34075dc..6c901d59e 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - jobs diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml index aa5abb994..27e911880 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_abort.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + post: tags: - jobs diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml index ac1933e94..ab0986406 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_progress.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - jobs diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml index 05eda8e2e..baa641be7 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_restore-jobs_jobId_slices.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + post: tags: - jobs diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml index cd0dbfa56..6683bc0f3 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - snapshots diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml index 3b01555d7..57cc5f572 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_component.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - components diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml index 3c8b490d0..f86503089 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_tables_table_snapshots_snapshot_components_index_component.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - components diff --git a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml index 8699032f9..c2fe84bbe 100644 --- a/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml +++ b/server/src/main/resources/openAPI/paths/keyspaces_keyspace_token-range-replicas.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - tokenrange diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml index ff5e9bacd..a845bc925 100644 --- a/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml +++ b/server/src/main/resources/openAPI/paths/schema_keyspaces.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - keyspaces diff --git a/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml b/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml index b895744bd..4f6e2f993 100644 --- a/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml +++ b/server/src/main/resources/openAPI/paths/schema_keyspaces_keyspace.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - keyspaces diff --git a/server/src/main/resources/openAPI/paths/time-skew.yaml b/server/src/main/resources/openAPI/paths/time-skew.yaml index d924b66d9..67dc2501a 100644 --- a/server/src/main/resources/openAPI/paths/time-skew.yaml +++ b/server/src/main/resources/openAPI/paths/time-skew.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + get: tags: - gossip diff --git a/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml index a972bd024..949add57c 100644 --- a/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml +++ b/server/src/main/resources/openAPI/paths/uploads_uploadId.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + delete: tags: - sstables diff --git a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml index 73e907676..e9c3d1075 100644 --- a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml +++ b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_components_component.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + put: tags: - sstables diff --git a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml index 012502f59..b78b4c166 100644 --- a/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml +++ b/server/src/main/resources/openAPI/paths/uploads_uploadId_keyspaces_keyspace_tables_table_import.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + put: tags: - sstables diff --git a/server/src/main/resources/openAPI/sidecarApi.yaml b/server/src/main/resources/openAPI/sidecarApi.yaml index 50e18a119..564a6ccea 100644 --- a/server/src/main/resources/openAPI/sidecarApi.yaml +++ b/server/src/main/resources/openAPI/sidecarApi.yaml @@ -1,3 +1,20 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + openapi: 3.1.0 info: title: Cassandra Sidecar API From ce9bb45e42f7ae01a4f1305fa58f3785f212a702 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Fri, 31 Jan 2025 13:42:30 -0800 Subject: [PATCH 10/11] Lower openAPI generator version to be compatible with java8 --- server/build.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server/build.gradle b/server/build.gradle index 742acbc66..b3f01dde8 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -31,7 +31,7 @@ plugins { // and produces a docker image id('com.google.cloud.tools.jib') version '3.4.4' // openAPI - id "org.openapi.generator" version "7.10.0" + id "org.openapi.generator" version "6.6.0" } sourceCompatibility = JavaVersion.VERSION_11 From c9153b1cdaad7d49d7e58ce926d19619551d2646 Mon Sep 17 00:00:00 2001 From: Bernardo Botella Corbi Date: Sun, 2 Feb 2025 19:49:59 -0800 Subject: [PATCH 11/11] Rebase and update plugin --- server/build.gradle | 2 +- .../main/resources/openAPI/paths/cassandra_gossip___health.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/server/build.gradle b/server/build.gradle index b3f01dde8..b7ce0ad4a 100644 --- a/server/build.gradle +++ b/server/build.gradle @@ -31,7 +31,7 @@ plugins { // and produces a docker image id('com.google.cloud.tools.jib') version '3.4.4' // openAPI - id "org.openapi.generator" version "6.6.0" + id "org.openapi.generator" version "7.11.0" } sourceCompatibility = JavaVersion.VERSION_11 diff --git a/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml b/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml index 56376c2bb..51afb18fa 100644 --- a/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml +++ b/server/src/main/resources/openAPI/paths/cassandra_gossip___health.yaml @@ -20,7 +20,7 @@ get: - healthchecks operationId: cassandraGossipHealthcheck description: Check Gossip health - summary: Endpoint used to perform gossip health checks to a Cassandra instance + summary: Endpoint used to check the gossip health of a Cassandra instance security: [] responses: '200':