RM-4595: changed all ocurences of IGNode to FilePlanComponent in

ig-core.yaml file
This commit is contained in:
Silviu Dinuta
2017-02-09 18:02:06 +02:00
parent f04022c036
commit b1033ad999

View File

@@ -36,7 +36,7 @@ paths:
operationId: getFileplanComponent operationId: getFileplanComponent
parameters: parameters:
- $ref: '#/parameters/fileplanComponentIdWithAliasParam' - $ref: '#/parameters/fileplanComponentIdWithAliasParam'
- $ref: '#/parameters/IGNodeEntryIncludeParam' - $ref: '#/parameters/FilePlanComponentEntryIncludeParam'
- $ref: '#/parameters/relativePathParam' - $ref: '#/parameters/relativePathParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
produces: produces:
@@ -45,7 +45,7 @@ paths:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/IGNodeEntry' $ref: '#/definitions/FilePlanComponentEntry'
'400': '400':
description: | description: |
Invalid parameter: **fileplanComponentId** is not a valid format Invalid parameter: **fileplanComponentId** is not a valid format
@@ -86,21 +86,21 @@ paths:
operationId: updateFileplanComponent operationId: updateFileplanComponent
parameters: parameters:
- $ref: '#/parameters/fileplanComponentIdWithAliasParam' - $ref: '#/parameters/fileplanComponentIdWithAliasParam'
- $ref: '#/parameters/IGNodeEntryIncludeParam' - $ref: '#/parameters/FilePlanComponentEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
name: nodeBodyUpdate name: nodeBodyUpdate
description: The node information to update. description: The node information to update.
required: true required: true
schema: schema:
$ref: '#/definitions/IGNodeBodyUpdate' $ref: '#/definitions/FilePlanComponentBodyUpdate'
produces: produces:
- application/json - application/json
responses: responses:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/IGNodeEntry' $ref: '#/definitions/FilePlanComponentEntry'
'400': '400':
description: | description: |
Invalid parameter: the update request is invalid or **fileplanComponentId** is not a valid format or **nodeBody** is invalid Invalid parameter: the update request is invalid or **fileplanComponentId** is not a valid format or **nodeBody** is invalid
@@ -175,7 +175,7 @@ paths:
- $ref: '#/parameters/maxItemsParam' - $ref: '#/parameters/maxItemsParam'
- $ref: '#/parameters/orderByParam' - $ref: '#/parameters/orderByParam'
- $ref: '#/parameters/whereParam' - $ref: '#/parameters/whereParam'
- $ref: '#/parameters/IGNodeEntryIncludeParam' - $ref: '#/parameters/FilePlanComponentEntryIncludeParam'
- $ref: '#/parameters/relativePathParam' - $ref: '#/parameters/relativePathParam'
- $ref: '#/parameters/includeSourceParam' - $ref: '#/parameters/includeSourceParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
@@ -183,7 +183,7 @@ paths:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/IGNodeAssociationPaging' $ref: '#/definitions/FilePlanComponentAssociationPaging'
'401': '401':
description: If authentication fails description: If authentication fails
'403': '403':
@@ -229,7 +229,7 @@ paths:
This API method also supports node creation using application/json. This API method also supports node creation using application/json.
You must specify at least a **name** and **nodeType**. You must specify at least a **name** and **nodeType**.
You can create a category like this: You can create a category like this:
```JSON ```JSON
@@ -306,7 +306,7 @@ paths:
} }
``` ```
The **relativePath** specifies the container structure to create relative to the node **nodeId**. Containers in the The **relativePath** specifies the container structure to create relative to the node **nodeId**. Containers in the
**relativePath** that do not exist are created before the node is created. The container type is decided considering **relativePath** that do not exist are created before the node is created. The container type is decided considering
the type of the parent container and the type of the node to be created. the type of the parent container and the type of the node to be created.
You can set properties when creating a new fileplan component: You can set properties when creating a new fileplan component:
@@ -324,7 +324,7 @@ paths:
Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field. Any missing aspects are applied automatically. You can set aspects explicitly, if needed, using an **aspectNames** field.
**Note:** You can create more than one child by **Note:** You can create more than one child by
specifying a list of nodes in the JSON body. For example, the following JSON specifying a list of nodes in the JSON body. For example, the following JSON
body creates two folders inside the specified **nodeId**, if the **nodeId** identifies body creates two folders inside the specified **nodeId**, if the **nodeId** identifies
a folder: a folder:
@@ -341,7 +341,7 @@ paths:
] ]
``` ```
If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example: If you specify a list as input, then a paginated list rather than an entry is returned in the response body. For example:
```JSON ```JSON
{ {
"list": { "list": {
@@ -375,7 +375,7 @@ paths:
description: If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix. description: If true, then a name clash will cause an attempt to auto rename by finding a unique name using an integer suffix.
required: false required: false
type: boolean type: boolean
- $ref: '#/parameters/IGNodeEntryIncludeParam' - $ref: '#/parameters/FilePlanComponentEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
name: nodeBodyCreate name: nodeBodyCreate
@@ -395,7 +395,7 @@ paths:
'201': '201':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/IGNodeEntry' $ref: '#/definitions/FilePlanComponentEntry'
'400': '400':
description: | description: |
Invalid parameter: **fileplanComponentId** is not a valid format or **nodeBodyCreate** is invalid Invalid parameter: **fileplanComponentId** is not a valid format or **nodeBodyCreate** is invalid
@@ -599,11 +599,11 @@ paths:
$ref: '#/definitions/Error' $ref: '#/definitions/Error'
'/records/{recordId}/file': '/records/{recordId}/file':
post: post:
tags: tags:
- records - records
summary: File a record summary: File a record
description: | description: |
Files the record **recordId** in the target record folder. Files the record **recordId** in the target record folder.
You can specify the target record folder by providing its id **targetParentId** You can specify the target record folder by providing its id **targetParentId**
or by providing the id of a parent container **targetParentId** and a relative path **relativePath**. or by providing the id of a parent container **targetParentId** and a relative path **relativePath**.
@@ -613,11 +613,11 @@ paths:
The relativePath is made of record containers and a record folder as the last element. The relativePath is made of record containers and a record folder as the last element.
Containers that are missing from relativePath will be created before filing. Containers that are missing from relativePath will be created before filing.
If the record is already filed, a link to the target record folder is created. If the record is already filed, a link to the target record folder is created.
operationId: fileRecord operationId: fileRecord
parameters: parameters:
- $ref: '#/parameters/recordIdParam' - $ref: '#/parameters/recordIdParam'
- $ref: '#/parameters/IGNodeEntryIncludeParam' - $ref: '#/parameters/FilePlanComponentEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
- in: body - in: body
name: nodeBodyFile name: nodeBodyFile
@@ -633,7 +633,7 @@ paths:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/IGNodeEntry' $ref: '#/definitions/FilePlanComponentEntry'
'400': '400':
description: | description: |
Invalid parameter: **recordIdParam** or **targetParentId** is not a valid format, Invalid parameter: **recordIdParam** or **targetParentId** is not a valid format,
@@ -654,12 +654,12 @@ paths:
$ref: '#/definitions/Error' $ref: '#/definitions/Error'
'/files/{fileId}/declare': '/files/{fileId}/declare':
post: post:
tags: tags:
- files - files
summary: Declare as record summary: Declare as record
description: Declares the file **fileId** in the unfiled record container. description: Declares the file **fileId** in the unfiled record container.
operationId: declareRecord operationId: declareRecord
parameters: parameters:
- name: fileId - name: fileId
in: path in: path
description: The identifier of a non-record file. description: The identifier of a non-record file.
@@ -670,7 +670,7 @@ paths:
description: Flag to indicate whether the record should be hidden from the current parent folder. description: Flag to indicate whether the record should be hidden from the current parent folder.
type: boolean type: boolean
default: false default: false
- $ref: '#/parameters/IGNodeEntryIncludeParam' - $ref: '#/parameters/FilePlanComponentEntryIncludeParam'
- $ref: '#/parameters/fieldsParam' - $ref: '#/parameters/fieldsParam'
consumes: consumes:
- application/json - application/json
@@ -680,7 +680,7 @@ paths:
'200': '200':
description: Successful response description: Successful response
schema: schema:
$ref: '#/definitions/IGNodeEntry' $ref: '#/definitions/FilePlanComponentEntry'
'400': '400':
description: | description: |
Invalid parameter: **fileId** is not a valid format Invalid parameter: **fileId** is not a valid format
@@ -742,7 +742,7 @@ parameters:
information is returned on the node resolved by this path. information is returned on the node resolved by this path.
required: false required: false
type: string type: string
IGNodeEntryIncludeParam: FilePlanComponentEntryIncludeParam:
name: include name: include
in: query in: query
description: | description: |
@@ -854,14 +854,14 @@ parameters:
type: string type: string
format: date-time format: date-time
definitions: definitions:
IGNodeEntry: FilePlanComponentEntry:
type: object type: object
required: required:
- entry - entry
properties: properties:
entry: entry:
$ref: '#/definitions/IGNode' $ref: '#/definitions/FilePlanComponent'
IGNode: FilePlanComponent:
type: object type: object
required: required:
- id - id
@@ -932,7 +932,7 @@ definitions:
type: string type: string
path: path:
$ref: '#/definitions/PathInfo' $ref: '#/definitions/PathInfo'
IGNodeAssociationPaging: FilePlanComponentAssociationPaging:
type: object type: object
properties: properties:
list: list:
@@ -943,24 +943,24 @@ definitions:
entries: entries:
type: array type: array
items: items:
$ref: '#/definitions/IGNodeChildAssociationEntry' $ref: '#/definitions/FilePlanComponentChildAssociationEntry'
source: source:
$ref: '#/definitions/IGNode' $ref: '#/definitions/FilePlanComponent'
IGNodeChildAssociationEntry: FilePlanComponentChildAssociationEntry:
type: object type: object
required: required:
- entry - entry
properties: properties:
entry: entry:
$ref: '#/definitions/IGNodeChildAssociation' $ref: '#/definitions/FilePlanComponentChildAssociation'
IGNodeChildAssociation: FilePlanComponentChildAssociation:
allOf: allOf:
- $ref: '#/definitions/IGNode' - $ref: '#/definitions/FilePlanComponent'
- type: object - type: object
properties: properties:
association: association:
$ref: '#/definitions/ChildAssociationInfo' $ref: '#/definitions/ChildAssociationInfo'
IGNodeBodyUpdate: FilePlanComponentBodyUpdate:
type: object type: object
properties: properties:
name: name: