From 6084178c20b8788d61787627fc43a9c690448b35 Mon Sep 17 00:00:00 2001 From: mikhailafanasev Date: Wed, 19 Mar 2025 13:19:46 +0100 Subject: [PATCH 1/5] Endpoint summary and id params description was updated --- openapi/v1/expressionCurator.yaml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/openapi/v1/expressionCurator.yaml b/openapi/v1/expressionCurator.yaml index 6ab89f7c..566bdd6b 100644 --- a/openapi/v1/expressionCurator.yaml +++ b/openapi/v1/expressionCurator.yaml @@ -319,7 +319,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Unique identifier (runId) of the run. in: path name: id required: true @@ -365,7 +365,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by run ID (accession) + summary: Retrieve a single group object by run ID (runId) tags: - Expression SPoT as Curator /api/v1/as-curator/expressions/group/{id}: @@ -378,7 +378,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Expression group identifier (groupId). in: path name: id required: true @@ -424,7 +424,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by ID (accession) + summary: Retrieve a single expression group by ID (groupId) tags: - Expression SPoT as Curator /api/v1/as-curator/expressions/runs/by/group/{id}: @@ -495,7 +495,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Expression object unique identifier (itemId). in: path name: id required: true @@ -541,7 +541,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single expression object by ID (accession) + summary: Retrieve a single expression object by ID (itemId) tags: - Expression SPoT as Curator patch: @@ -556,7 +556,7 @@ paths: The attribute values are intelligently parsed as booleans, integers, etc. operationId: updateExpressionRunAsCurator parameters: - - description: Unique identifier (accession) of the object. + - description: Expression object runId. in: path name: id required: true @@ -596,7 +596,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Update object metadata + summary: Update metadata object by expression object ID (runId) tags: - Expression SPoT as Curator x-codegen-request-body-name: body @@ -604,7 +604,7 @@ paths: get: operationId: getExpressionVersionsAsCurator parameters: - - description: Unique identifier (accession) of the object. + - description: Expression object run ID (runId). in: path name: id required: true @@ -633,7 +633,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a list of object versions by ID + summary: Retrieve a list of expression object versions by ID (runId) tags: - Expression SPoT as Curator /api/v1/as-curator/expressions/{id}/versions/{version}: @@ -646,13 +646,13 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Expression object run ID (runId). in: path name: id required: true schema: type: string - - description: Unique version of the object. + - description: Unique version of the expression object. in: path name: version required: true @@ -698,7 +698,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single expression object by ID (accession) + summary: Retrieve a single expression object by run ID and its version tags: - Expression SPoT as Curator components: From c174e293e159e7170be3421a62d02afe5aab8d55 Mon Sep 17 00:00:00 2001 From: mikhailafanasev Date: Wed, 19 Mar 2025 13:25:51 +0100 Subject: [PATCH 2/5] Endpoint summary and id params description was updated --- openapi/v1/odmApi.yaml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/openapi/v1/odmApi.yaml b/openapi/v1/odmApi.yaml index 416a1449..4cc40ef0 100644 --- a/openapi/v1/odmApi.yaml +++ b/openapi/v1/odmApi.yaml @@ -382,7 +382,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Unique identifier (runId) of the run." in: "path" name: "id" required: true @@ -430,7 +430,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by run ID (accession)" + summary: "Retrieve a single group object by run ID (runId)" tags: - "Expression SPoT as Curator" /api/v1/as-curator/expressions/group/{id}: @@ -443,7 +443,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Expression group identifier (groupId)." in: "path" name: "id" required: true @@ -491,7 +491,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by ID (accession)" + summary: "Retrieve a single expression group by ID (groupId)" tags: - "Expression SPoT as Curator" /api/v1/as-curator/expressions/runs/by/group/{id}: @@ -568,7 +568,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Expression object unique identifier (itemId)." in: "path" name: "id" required: true @@ -616,7 +616,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single expression object by ID (accession)" + summary: "Retrieve a single expression object by ID (itemId)" tags: - "Expression SPoT as Curator" patch: @@ -630,7 +630,7 @@ paths: \ parsed as booleans, integers, etc." operationId: "updateExpressionRunAsCurator" parameters: - - description: "Unique identifier (accession) of the object." + - description: "Expression object runId." in: "path" name: "id" required: true @@ -671,7 +671,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Update object metadata" + summary: "Update metadata object by expression object ID (runId)" tags: - "Expression SPoT as Curator" x-codegen-request-body-name: "body" @@ -679,7 +679,7 @@ paths: get: operationId: "getExpressionVersionsAsCurator" parameters: - - description: "Unique identifier (accession) of the object." + - description: "Expression object run ID (runId)." in: "path" name: "id" required: true @@ -709,7 +709,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a list of object versions by ID" + summary: "Retrieve a list of expression object versions by ID (runId)" tags: - "Expression SPoT as Curator" /api/v1/as-curator/expressions/{id}/versions/{version}: @@ -722,13 +722,13 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Expression object run ID (runId)." in: "path" name: "id" required: true schema: type: "string" - - description: "Unique version of the object." + - description: "Unique version of the expression object." in: "path" name: "version" required: true @@ -776,7 +776,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single expression object by ID (accession)" + summary: "Retrieve a single expression object by run ID and its version" tags: - "Expression SPoT as Curator" /api/v1/as-user/expressions: From 469466bb14c0ae3c8968f46167803e255e9fd3d7 Mon Sep 17 00:00:00 2001 From: mikhailafanasev Date: Wed, 19 Mar 2025 16:12:10 +0100 Subject: [PATCH 3/5] Summary and description consistency --- openapi/v1/expressionCurator.yaml | 6 +++--- openapi/v1/odmApi.yaml | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/openapi/v1/expressionCurator.yaml b/openapi/v1/expressionCurator.yaml index 566bdd6b..ce9ee683 100644 --- a/openapi/v1/expressionCurator.yaml +++ b/openapi/v1/expressionCurator.yaml @@ -556,7 +556,7 @@ paths: The attribute values are intelligently parsed as booleans, integers, etc. operationId: updateExpressionRunAsCurator parameters: - - description: Expression object runId. + - description: Expression object run ID (runId). in: path name: id required: true @@ -596,7 +596,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Update metadata object by expression object ID (runId) + summary: Update metadata object by expression object run ID (runId) tags: - Expression SPoT as Curator x-codegen-request-body-name: body @@ -633,7 +633,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a list of expression object versions by ID (runId) + summary: Retrieve a list of expression object versions by run ID (runId) tags: - Expression SPoT as Curator /api/v1/as-curator/expressions/{id}/versions/{version}: diff --git a/openapi/v1/odmApi.yaml b/openapi/v1/odmApi.yaml index 4cc40ef0..f54e14fc 100644 --- a/openapi/v1/odmApi.yaml +++ b/openapi/v1/odmApi.yaml @@ -630,7 +630,7 @@ paths: \ parsed as booleans, integers, etc." operationId: "updateExpressionRunAsCurator" parameters: - - description: "Expression object runId." + - description: "Expression object run ID (runId)." in: "path" name: "id" required: true @@ -671,7 +671,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Update metadata object by expression object ID (runId)" + summary: "Update metadata object by expression object run ID (runId)" tags: - "Expression SPoT as Curator" x-codegen-request-body-name: "body" @@ -709,7 +709,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a list of expression object versions by ID (runId)" + summary: "Retrieve a list of expression object versions by run ID (runId)" tags: - "Expression SPoT as Curator" /api/v1/as-curator/expressions/{id}/versions/{version}: From 516cb25c8d7748dbaaa58da36df28001e563be95 Mon Sep 17 00:00:00 2001 From: mikhailafanasev Date: Mon, 24 Mar 2025 12:17:55 +0100 Subject: [PATCH 4/5] expressionUser summary and description consistency --- openapi/v1/expressionUser.yaml | 20 ++++++++++---------- openapi/v1/odmApi.yaml | 20 ++++++++++---------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/openapi/v1/expressionUser.yaml b/openapi/v1/expressionUser.yaml index 902a9d22..1dd1ab8a 100644 --- a/openapi/v1/expressionUser.yaml +++ b/openapi/v1/expressionUser.yaml @@ -320,7 +320,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Unique identifier (runId) of the run. in: path name: id required: true @@ -366,7 +366,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by run ID (accession) + summary: Retrieve a single group object by run ID (runId) tags: - Expression SPoT as User /api/v1/as-user/expressions/group/{id}: @@ -379,7 +379,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Expression group identifier (groupId). in: path name: id required: true @@ -425,7 +425,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by ID (accession) + summary: Retrieve a single expression group by ID (groupId) tags: - Expression SPoT as User /api/v1/as-user/expressions/runs/by/group/{id}: @@ -496,7 +496,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Expression object unique identifier (itemId). in: path name: id required: true @@ -542,14 +542,14 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single expression object by ID (accession) + summary: Retrieve a single expression object by ID (itemId) tags: - Expression SPoT as User /api/v1/as-user/expressions/{id}/versions: get: operationId: getExpressionVersionsAsUser parameters: - - description: Unique identifier (accession) of the object. + - description: Expression object run ID (runId). in: path name: id required: true @@ -578,7 +578,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a list of object versions by ID + summary: Retrieve a list of expression object versions by run ID (runId) tags: - Expression SPoT as User /api/v1/as-user/expressions/{id}/versions/{version}: @@ -591,7 +591,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Expression object run ID (runId). in: path name: id required: true @@ -643,7 +643,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single expression object by ID (accession) + summary: Retrieve a single expression object by run ID and its version tags: - Expression SPoT as User components: diff --git a/openapi/v1/odmApi.yaml b/openapi/v1/odmApi.yaml index f54e14fc..0ab15751 100644 --- a/openapi/v1/odmApi.yaml +++ b/openapi/v1/odmApi.yaml @@ -1100,7 +1100,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Unique identifier (runId) of the run." in: "path" name: "id" required: true @@ -1148,7 +1148,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by run ID (accession)" + summary: "Retrieve a single group object by run ID (runId)" tags: - "Expression SPoT as User" /api/v1/as-user/expressions/group/{id}: @@ -1161,7 +1161,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Expression group identifier (groupId)." in: "path" name: "id" required: true @@ -1209,7 +1209,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by ID (accession)" + summary: "Retrieve a single expression group by ID (groupId)" tags: - "Expression SPoT as User" /api/v1/as-user/expressions/runs/by/group/{id}: @@ -1286,7 +1286,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Expression object unique identifier (itemId)." in: "path" name: "id" required: true @@ -1334,14 +1334,14 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single expression object by ID (accession)" + summary: "Retrieve a single expression object by ID (itemId)" tags: - "Expression SPoT as User" /api/v1/as-user/expressions/{id}/versions: get: operationId: "getExpressionVersionsAsUser" parameters: - - description: "Unique identifier (accession) of the object." + - description: "Expression object run ID (runId)." in: "path" name: "id" required: true @@ -1371,7 +1371,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a list of object versions by ID" + summary: "Retrieve a list of expression object versions by run ID (runId)" tags: - "Expression SPoT as User" /api/v1/as-user/expressions/{id}/versions/{version}: @@ -1384,7 +1384,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Expression object run ID (runId)." in: "path" name: "id" required: true @@ -1438,7 +1438,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single expression object by ID (accession)" + summary: "Retrieve a single expression object by run ID and its version" tags: - "Expression SPoT as User" /api/v1/as-curator/files/{id}/download: From 5497c07b08b7c26dd111506cdc2b23ab16a1c11e Mon Sep 17 00:00:00 2001 From: mikhailafanasev Date: Mon, 24 Mar 2025 13:09:29 +0100 Subject: [PATCH 5/5] variantUser and Curator summary and description consistency --- openapi/v1/odmApi.yaml | 44 +++++++++++++++++----------------- openapi/v1/variantCurator.yaml | 22 ++++++++--------- openapi/v1/variantUser.yaml | 22 ++++++++--------- 3 files changed, 44 insertions(+), 44 deletions(-) diff --git a/openapi/v1/odmApi.yaml b/openapi/v1/odmApi.yaml index 0ab15751..6b3647f4 100644 --- a/openapi/v1/odmApi.yaml +++ b/openapi/v1/odmApi.yaml @@ -20943,7 +20943,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Unique identifier (runId) of the run." in: "path" name: "id" required: true @@ -20991,7 +20991,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by run ID (accession)" + summary: "Retrieve a single group object by run ID (runId)" tags: - "Variant SPoT as Curator" /api/v1/as-curator/variants/group/{id}: @@ -21004,7 +21004,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Variant group identifier (groupId)." in: "path" name: "id" required: true @@ -21052,7 +21052,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by ID (accession)" + summary: "Retrieve a single variant group by ID (groupId)" tags: - "Variant SPoT as Curator" /api/v1/as-curator/variants/runs/by/group/{id}: @@ -21129,7 +21129,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Variant object unique identifier (itemId)." in: "path" name: "id" required: true @@ -21177,14 +21177,14 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single variant object by ID (accession)" + summary: "Retrieve a single variant object by ID (itemId)" tags: - "Variant SPoT as Curator" /api/v1/as-curator/variants/{id}/versions: get: operationId: "getVariantVersionsAsCurator" parameters: - - description: "Unique identifier (accession) of the object." + - description: "Variant object run ID (runId)." in: "path" name: "id" required: true @@ -21214,7 +21214,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a list of object versions by ID" + summary: "Retrieve a list of variant object versions by run ID (runId)" tags: - "Variant SPoT as Curator" /api/v1/as-curator/variants/{id}/versions/{version}: @@ -21227,13 +21227,13 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Variant object run ID (runId)." in: "path" name: "id" required: true schema: type: "string" - - description: "Unique version of the object." + - description: "Unique version of the variant object." in: "path" name: "version" required: true @@ -21281,7 +21281,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single variant object by ID (accession)" + summary: "Retrieve a single variant object by run ID and its version" tags: - "Variant SPoT as Curator" /api/v1/as-user/variants: @@ -21646,7 +21646,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Unique identifier (runId) of the run." in: "path" name: "id" required: true @@ -21694,7 +21694,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by run ID (accession)" + summary: "Retrieve a single group object by run ID (runId)" tags: - "Variant SPoT as User" /api/v1/as-user/variants/group/{id}: @@ -21707,7 +21707,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Variant group identifier (groupId)." in: "path" name: "id" required: true @@ -21755,7 +21755,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single group object by ID (accession)" + summary: "Retrieve a single variant group by ID (groupId)" tags: - "Variant SPoT as User" /api/v1/as-user/variants/runs/by/group/{id}: @@ -21832,7 +21832,7 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Variant object unique identifier (itemId)." in: "path" name: "id" required: true @@ -21880,14 +21880,14 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single variant object by ID (accession)" + summary: "Retrieve a single variant object by ID (itemId)" tags: - "Variant SPoT as User" /api/v1/as-user/variants/{id}/versions: get: operationId: "getVariantVersionsAsUser" parameters: - - description: "Unique identifier (accession) of the object." + - description: "Variant object run ID (runId)." in: "path" name: "id" required: true @@ -21917,7 +21917,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a list of object versions by ID" + summary: "Retrieve a list of variant object versions by run ID (runId)" tags: - "Variant SPoT as User" /api/v1/as-user/variants/{id}/versions/{version}: @@ -21930,13 +21930,13 @@ paths: name: "responseFormat" schema: $ref: "#/components/schemas/ResponseFormat" - - description: "Unique identifier (accession) of the object." + - description: "Variant object run ID (runId)." in: "path" name: "id" required: true schema: type: "string" - - description: "Unique version of the object." + - description: "Unique version of the variant object." in: "path" name: "version" required: true @@ -21984,7 +21984,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: "Retrieve a single variant object by ID (accession)" + summary: "Retrieve a single variant object by run ID and its version" tags: - "Variant SPoT as User" components: diff --git a/openapi/v1/variantCurator.yaml b/openapi/v1/variantCurator.yaml index adda14e5..581a6177 100644 --- a/openapi/v1/variantCurator.yaml +++ b/openapi/v1/variantCurator.yaml @@ -351,7 +351,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Unique identifier (runId) of the run. in: path name: id required: true @@ -397,7 +397,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by run ID (accession) + summary: Retrieve a single group object by run ID (runId) tags: - Variant SPoT as Curator /api/v1/as-curator/variants/group/{id}: @@ -410,7 +410,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Variant group identifier (groupId). in: path name: id required: true @@ -456,7 +456,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by ID (accession) + summary: Retrieve a single variant group by ID (groupId) tags: - Variant SPoT as Curator /api/v1/as-curator/variants/runs/by/group/{id}: @@ -527,7 +527,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Variant object unique identifier (itemId). in: path name: id required: true @@ -573,14 +573,14 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single variant object by ID (accession) + summary: Retrieve a single variant object by ID (itemId) tags: - Variant SPoT as Curator /api/v1/as-curator/variants/{id}/versions: get: operationId: getVariantVersionsAsCurator parameters: - - description: Unique identifier (accession) of the object. + - description: Variant object run ID (runId). in: path name: id required: true @@ -609,7 +609,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a list of object versions by ID + summary: Retrieve a list of variant object versions by run ID (runId) tags: - Variant SPoT as Curator /api/v1/as-curator/variants/{id}/versions/{version}: @@ -622,13 +622,13 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Variant object run ID (runId). in: path name: id required: true schema: type: string - - description: Unique version of the object. + - description: Unique version of the variant object. in: path name: version required: true @@ -674,7 +674,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single variant object by ID (accession) + summary: Retrieve a single variant object by run ID and its version tags: - Variant SPoT as Curator components: diff --git a/openapi/v1/variantUser.yaml b/openapi/v1/variantUser.yaml index 6ec06af3..8e60d677 100644 --- a/openapi/v1/variantUser.yaml +++ b/openapi/v1/variantUser.yaml @@ -352,7 +352,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Unique identifier (runId) of the run. in: path name: id required: true @@ -398,7 +398,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by run ID (accession) + summary: Retrieve a single group object by run ID (runId) tags: - Variant SPoT as User /api/v1/as-user/variants/group/{id}: @@ -411,7 +411,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Variant group identifier (groupId). in: path name: id required: true @@ -457,7 +457,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single group object by ID (accession) + summary: Retrieve a single variant group by ID (groupId) tags: - Variant SPoT as User /api/v1/as-user/variants/runs/by/group/{id}: @@ -528,7 +528,7 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Variant object unique identifier (itemId). in: path name: id required: true @@ -574,14 +574,14 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single variant object by ID (accession) + summary: Retrieve a single variant object by ID (itemId) tags: - Variant SPoT as User /api/v1/as-user/variants/{id}/versions: get: operationId: getVariantVersionsAsUser parameters: - - description: Unique identifier (accession) of the object. + - description: Variant object run ID (runId). in: path name: id required: true @@ -610,7 +610,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a list of object versions by ID + summary: Retrieve a list of variant object versions by run ID (runId) tags: - Variant SPoT as User /api/v1/as-user/variants/{id}/versions/{version}: @@ -623,13 +623,13 @@ paths: name: responseFormat schema: $ref: "#/components/schemas/ResponseFormat" - - description: Unique identifier (accession) of the object. + - description: Variant object run ID (runId). in: path name: id required: true schema: type: string - - description: Unique version of the object. + - description: Unique version of the variant object. in: path name: version required: true @@ -675,7 +675,7 @@ paths: security: - Access-token: [] - Genestack-API-Token: [] - summary: Retrieve a single variant object by ID (accession) + summary: Retrieve a single variant object by run ID and its version tags: - Variant SPoT as User components: