Skip to content
Snippets Groups Projects
Commit fcfc2e26 authored by Larissa Pereira's avatar Larissa Pereira
Browse files

updating documentation

parent add7ed1a
No related branches found
No related tags found
1 merge request!483Fix permissions for soft delete
Pipeline #136157 failed
Pipeline: Storage

#136160

    ......@@ -219,7 +219,7 @@ paths:
    - "records"
    summary: "Delete record"
    description: "The API performs a logical deletion of the given record. This\
    \ operation can be reverted later. Allowed roles: service.storage.creator\
    \ operation can be reverted later. This operation can be performed by the owner only. Allowed roles: service.storage.creator\
    \ and service.storage.admin."
    operationId: "Delete record"
    consumes:
    ......@@ -256,7 +256,7 @@ paths:
    tags:
    - records
    summary: Soft delete of multiple records
    description: "The API performs a soft deletion of the given list of records. Required roles: 'users.datalake.editors' or
    description: "The API performs a soft deletion of the given list of records. This operation can be performed by the owner only. Required roles: 'users.datalake.editors' or
    'users.datalake.admins'."
    operationId: Delete records
    parameters:
    ......@@ -344,7 +344,7 @@ paths:
    - "records"
    summary: "Purge record"
    description: "The API performs the physical deletion of the given record and\
    \ all of its versions. This operation cannot be undone. Allowed roles: service.storage.admin."
    \ all of its versions. This operation cannot be undone. This operation can be performed by the owner only. Allowed roles: service.storage.admin."
    operationId: "Purge record"
    consumes:
    - "application/json"
    ......
    ......@@ -385,7 +385,7 @@ curl --request GET \
    ### Delete record <a name="Delete-record"></a>
    The API performs a logical deletion of the given record. This operation can be reverted later. The operation should be done by the owner only
    The API performs a logical deletion of the given record. This operation can be reverted later. The operation can be performed by the owner only
    ```
    POST /api/storage/v2/records/{id}:delete
    ```
    ......@@ -403,7 +403,7 @@ curl --request POST \
    </details>
    ### Delete records <a name="Delete-records"></a>
    The API performs a logical deletion of batch of record (max size of a batch is 500 records). This operation can be reverted later by ingesting record with the same id one more time. The deleted (inactive) records will be removed from the index, and therefore will not be returned to the search result.
    The API performs a logical deletion of batch of record (max size of a batch is 500 records). This operation can be reverted later by ingesting record with the same id one more time. The deleted (inactive) records will be removed from the index, and therefore will not be returned to the search result. This operation can be performed by the owner only.
    ```
    POST /api/storage/v2/records/delete
    ```
    ......@@ -767,4 +767,4 @@ properties:
    - `version.info.buildPropertiesPath`
    - `version.info.gitPropertiesPath`
    [Back to table of contents](#TOC)
    [Back to table of contents](#TOC)
    \ No newline at end of file
    ......@@ -117,4 +117,4 @@ azure.publisher.batchsize=50
    #PubSub configuration
    azure.eventGrid.enabled=true
    azure.serviceBus.enabled =true
    azure.pubsub.publish=true
    azure.pubsub.publish=true
    \ No newline at end of file
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Finish editing this message first!
    Please register or to comment