RM-4429 - moved declare action in files endpoint

This commit is contained in:
Ana Bozianu
2016-12-16 16:50:05 +02:00
parent cfc6510b37
commit 10405e4e73

View File

@@ -21,6 +21,8 @@ tags:
description: Retrieve and manage the RM site description: Retrieve and manage the RM site
- name: records - name: records
description: Perform record specific operations description: Perform record specific operations
- name: files
description: Perform operations on non-record files
paths: paths:
'/fileplan-components/{fileplanComponentId}': '/fileplan-components/{fileplanComponentId}':
get: get:
@@ -650,15 +652,15 @@ paths:
description: Unexpected error description: Unexpected error
schema: schema:
$ref: '#/definitions/Error' $ref: '#/definitions/Error'
'/records/{nodeId}/declare': '/files/{fileId}/declare':
post: post:
tags: tags:
- records - files
summary: Declare a record summary: Declare as record
description: Declares the file **nodeId** in the unfiled record container. description: Declares the file **fileId** in the unfiled record container.
operationId: declareRecord operationId: declareRecord
parameters: parameters:
- name: nodeId - name: fileId
in: path in: path
description: The identifier of a non-record file. description: The identifier of a non-record file.
required: true required: true
@@ -681,14 +683,14 @@ paths:
$ref: '#/definitions/IGNodeEntry' $ref: '#/definitions/IGNodeEntry'
'400': '400':
description: | description: |
Invalid parameter: **nodeId** is not a valid format Invalid parameter: **fileId** is not a valid format
'401': '401':
description: Authentication failed description: Authentication failed
'403': '403':
description: Current user does not have permission to declare a record description: Current user does not have permission to declare a record
'404': '404':
description: | description: |
**nodeId** does not exist **fileId** does not exist
'422': '422':
description: | description: |
Model integrity exception: the action breaks system's integrity restrictions Model integrity exception: the action breaks system's integrity restrictions