Commit f974a910 authored by Duo Chen's avatar Duo Chen
Browse files

Fix the grammer errors.

parent a69a7011
Pipeline #48061 passed with stages
in 12 minutes and 21 seconds
......@@ -44,7 +44,7 @@ basePath: /seistore-svc/api/v3
paths:
/svcstatus:
get:
summary: "Seismic store service status (fast check)"
summary: "Seismic store service status (fast check)."
description: "<ul><li>Return the seismic store service status.</li><li>Required roles: none</li></ul>"
security:
- api-key: []
......@@ -53,57 +53,57 @@ paths:
- General
responses:
200:
description: "service status"
description: "Service status."
schema:
type: string
example: "service OK"
/svcstatus/access:
get:
summary: "Seismic store service status"
summary: "Seismic store service status."
description: "<ul><li>Return the seismic store service status.</li><li>Required roles: none</li></ul>"
operationId: service-status-check
tags:
- General
responses:
200:
description: "seismic store service status"
description: "Seismic store service status."
schema:
$ref: "#/definitions/Status"
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
/dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}:
post:
summary: "Register a new dataset"
description: "<ul><li>Register a new dataset in seismic store.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
summary: "Register a new dataset."
description: "<ul><li>Register a new dataset in the seismic store.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
operationId: dataset-register
tags:
- Dataset
parameters:
- description: "Legal tag of the dataset"
- description: "Legal tag of the dataset."
in: header
name: ltag
type: string
required: false
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
......@@ -116,90 +116,94 @@ paths:
$ref: "#/definitions/DatasetRegisterBody"
responses:
200:
description: "Registered dataset metadata"
description: "Registered dataset metadata."
schema:
$ref: "#/definitions/Dataset"
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
409:
description: "Conflict"
description: "Conflict."
423:
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul><li>WL(Write Locked)</li><li>RL(Read Locked)</li><li>CL(Cannot be Locked)</li><li>UL(Cannot be Unlocked)</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600sec"
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
<li>WL (Write Locked).</li>
<li>RL (Read Locked).</li>
<li>CL (Cannot be Locked).</li>
<li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
get:
summary: "Retrieve a dataset"
description: "<ul><li>Return the dataset metadata from seismic store.</li><li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
summary: "Retrieve a dataset."
description: "<ul><li>Return the dataset metadata from the seismic store.</li><li>Required roles: subproject.admin, subproject.editor, subproject.viewer</li></ul>"
operationId: dataset-get
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
type: string
- description: "Include the seismic storage metadata record if it exists"
- description: "Include the seismic storage metadata record if it exists."
in: query
name: seismicmeta
required: false
type: boolean
responses:
200:
description: "Metadata of the dataset"
description: "Metadata of the dataset."
schema:
$ref: "#/definitions/Dataset"
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
delete:
summary: "Delete a dataset"
description: "<ul><li>Delete a dataset in seismic store.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
summary: "Delete a dataset."
description: "<ul><li>Delete a dataset in the seismic store.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
operationId: dataset-delete
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
......@@ -208,38 +212,47 @@ paths:
200:
description: "The resource was deleted successfully."
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
patch:
summary: "Patch the dataset metadata"
description: "<ul><li>Update the dataset meta information in seismic store or close(unlock) the dataset. If the endpoint is used without the close parameter, at least one body field is required or the endpoint will return an error.</li><li>Required roles: subproject.admin, subproject.editor</li><li>Patchable fields: <ul><li><b>dataset_new_name:</b> new name to use for the dataset (rename)
</li><li><b>filemetadata:</b> this is a seistore specific field and describe how the physical data are stored in the cloud storage system (GCS/AzureContainer etc etc). This metadata is mainly used by client libraries to correctly reconstruct the dataset. For example you can store a dataset as truncated in multiple objects of 64MB each, name them from 0 to N and save the filemetadata = “{nOboject: N, totalSize: 1024, objsize: 64, sizeUnit: MB }”.</li><li><b>last_modified_date:</b> mark this field as true to update the dataset last modified date</li><li><b>gtags:</b> upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.</li><li><b>ltag:</b> update the existing legalTag value</b></li><li><b>readonly:</b> update the dataset mode to readonly(true) or to read/write(false)</li><li><b>seismicmeta:</b> update the DataEcosystem storage metadata (refer to the DataEcosystem storage service tutorial for more help)</b></li></ul></li></ul>"
summary: "Patch the dataset metadata."
description: "<ul>
<li>Update the dataset meta information in the seismic store or close (unlock) the dataset. If the endpoint is used without the close parameter, at least one body field is required or the endpoint will return an error.</li>
<li>Required roles: subproject.admin, subproject.editor</li>
<li>Patchable fields: <ul>
<li><b>dataset_new_name:</b> new name to use for the dataset (rename).</li>
<li><b>filemetadata:</b> This is a seismic store specific field and describes how the physical data is stored in the cloud storage system (GCS/AzureContainer etc.). This metadata is mainly used by client libraries to correctly reconstruct the dataset. For example you can store a dataset as truncated in multiple objects of 64MB each, name them from 0 to N and save the filemetadata = “{nOboject: N, totalSize: 1024, objsize: 64, sizeUnit: MB}”.</li>
<li><b>last_modified_date:</b> Mark this field as true to update the dataset last modified date.</li>
<li><b>gtags:</b> Upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.</li>
<li><b>ltag:</b> Update the existing legalTag value.</b></li>
<li><b>readonly:</b> Update the dataset mode to readonly (true) or to read/write (false).</li>
<li><b>seismicmeta:</b> Update the Data Ecosystem storage metadata. (Refer to the Data Ecosystem storage service tutorial for more information.)</b></li></ul></li></ul>"
operationId: dataset-patch
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
......@@ -249,82 +262,93 @@ paths:
name: request body
schema:
$ref: "#/definitions/DatasetPatch"
- description: "Non null sbit value of the dataset. Using this value here will close the dataset"
- description: "Non null sbit value of the dataset. Using this value here will close the dataset."
in: query
name: close
required: false
type: string
responses:
200:
description: "Metadata of the patched dataset"
description: "Metadata of the patched dataset."
schema:
$ref: "#/definitions/Dataset"
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
409:
description: "Conflict"
description: "Conflict."
423:
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul><li>WL(Write Locked)</li><li>RL(Read Locked)</li><li>CL(Cannot be Locked)</li><li>UL(Cannot be Unlocked)</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600sec"
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
<li>WL (Write Locked).</li>
<li>RL (Read Locked).</li>
<li>CL (Cannot be Locked).</li>
<li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
/dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/lock:
put:
summary: "Acquire a lock for a dataset id"
description: "<ul><li>Open a dataset for read or write and lock its state.</li><li>Required roles open lock for write: subproject.admin, subproject.editor</li><li>Required roles open lock for read: subproject.admin, subproject.editor, subproject.viewer</ul>"
summary: "Acquire a lock for a dataset id."
description: "<ul>
<li>Open a dataset for read or write and lock its state.</li>
<li>Required roles open lock for write: subproject.admin, subproject.editor</li>
<li>Required roles open lock for read: subproject.admin, subproject.editor, subproject.viewer</ul>"
operationId: dataset-lock
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
type: string
- description: "Type of the lock which can be set to 'read' (default) or 'write'"
- description: "Type of the lock which can be set to 'read' (default) or 'write'."
in: query
name: openmode
required: false
type: string
- description: "Session identifier issued for a previous write lock acquisition operation"
- description: "Session identifier issued for a previous write lock acquisition operation."
in: query
name: wid
required: false
type: number
responses:
200:
description: "Acquired a lock and the return value is the dataset metadata with session identifier stored in 'sbit' attribute"
description: "Acquired a lock and the return value is the dataset metadata with session identifier stored in the 'sbit' attribute."
schema:
$ref: "#/definitions/Dataset"
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
423:
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul><li>WL(Write Locked)</li><li>RL(Read Locked)</li><li>CL(Cannot be Locked)</li><li>UL(Cannot be Unlocked)</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600sec"
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
<li>WL (Write Locked).</li>
<li>RL (Read Locked).</li>
<li>CL (Cannot be Locked).</li>
<li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
/dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/unlock:
put:
......@@ -334,39 +358,43 @@ paths:
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path for the dataset"
- description: "Hierarchical path for the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
type: string
responses:
200:
description: "Removed the lock value associated with dataset id"
description: "Removed the lock value associated with dataset id."
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
423:
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul><li>WL(Write Locked)</li><li>RL(Read Locked)</li><li>CL(Cannot be Locked)</li><li>UL(Cannot be Unlocked)</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600sec"
description: "Locked. The error message contains the Reason in the form <b>[RCODE:REASON(2-char-code)TTL(sec-number)]</b>. Possible Reasons code are: <ul>
<li>WL (Write Locked).</li>
<li>RL (Read Locked).</li>
<li>CL (Cannot be Locked).</li>
<li>UL (Cannot be Unlocked).</ul>\nFor example the reason code <b>[RCODE:RL3600]</b> indicates the dataset is Read Locked with a TTL of 3600 seconds."
/dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/permission:
get:
......@@ -376,22 +404,22 @@ paths:
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path for the dataset"
- description: "Hierarchical path for the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
......@@ -402,13 +430,13 @@ paths:
schema:
$ref: "#/definitions/DatasetPermission"
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
/dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/ctagcheck:
get:
......@@ -418,75 +446,77 @@ paths:
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
type: string
- description: "Ctag to be validated"
- description: "Ctag to be validated."
in: query
name: ctag
required: true
type: string
responses:
200:
description: "Return true if the ctag is valid or false if it is invalid"
description: "Return true if the ctag is valid or false if it is invalid."
schema:
type: boolean
example: "true"
400:
description: "Bad request"
description: "Bad request."
401:
description: "Unauthorized"
description: "Unauthorized."
403:
description: "Forbidden"
description: "Forbidden."
404:
description: "Not found"
description: "Not found."
/dataset/tenant/{tenantid}/subproject/{subprojectid}/dataset/{datasetid}/gtags:
put:
summary: "Upsert tags to a dataset"
description: "<ul><li>Upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.</li><li>Required roles: subproject.admin, subproject.editor</li></ul>"
summary: "Upsert tags to a dataset."
description: "<ul>
<li>Upsert tags to an existing dataset metadata. If the dataset metadata already has gtags, then new gtags are appended to this list.</li>
<li>Required roles: subproject.admin, subproject.editor</li></ul>"
operationId: add-tag
tags:
- Dataset
parameters:
- description: "Name of the tenant"
- description: "Name of the tenant."
in: path
name: tenantid
required: true
type: string
- description: "Name of the subproject"
- description: "Name of the subproject."
in: path
name: subprojectid
required: true
type: string
- description: "Hierarchical path of the dataset"
- description: "Hierarchical path of the dataset."
in: query
name: path
required: true
type: string
- description: "Name of the dataset"
- description: "Name of the dataset."
in: path
name: datasetid
required: true
type: string
- description: "Gtags array list"
- description: "Gtags array list."
in: query
name: gtag
required: true
......@@ -499,34 +529,36 @@ paths:
200:
description: "Gtags were upserted to the dataset metadata."
400:
description: "Bad request"
description: "Bad