diff --git a/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml b/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml index 7550e5c147..5cba27939b 100644 --- a/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml +++ b/rm-community/rm-community-rest-api-explorer/src/main/webapp/definitions/ig-core-api.yaml @@ -36,7 +36,7 @@ paths: operationId: getFileplanComponent parameters: - $ref: '#/parameters/fileplanComponentIdWithAliasParam' - - $ref: '#/parameters/IGNodeEntryIncludeParam' + - $ref: '#/parameters/FilePlanComponentEntryIncludeParam' - $ref: '#/parameters/relativePathParam' - $ref: '#/parameters/fieldsParam' produces: @@ -45,7 +45,7 @@ paths: '200': description: Successful response schema: - $ref: '#/definitions/IGNodeEntry' + $ref: '#/definitions/FilePlanComponentEntry' '400': description: | Invalid parameter: **fileplanComponentId** is not a valid format @@ -86,21 +86,21 @@ paths: operationId: updateFileplanComponent parameters: - $ref: '#/parameters/fileplanComponentIdWithAliasParam' - - $ref: '#/parameters/IGNodeEntryIncludeParam' + - $ref: '#/parameters/FilePlanComponentEntryIncludeParam' - $ref: '#/parameters/fieldsParam' - in: body name: nodeBodyUpdate description: The node information to update. required: true schema: - $ref: '#/definitions/IGNodeBodyUpdate' + $ref: '#/definitions/FilePlanComponentBodyUpdate' produces: - application/json responses: '200': description: Successful response schema: - $ref: '#/definitions/IGNodeEntry' + $ref: '#/definitions/FilePlanComponentEntry' '400': description: | 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/orderByParam' - $ref: '#/parameters/whereParam' - - $ref: '#/parameters/IGNodeEntryIncludeParam' + - $ref: '#/parameters/FilePlanComponentEntryIncludeParam' - $ref: '#/parameters/relativePathParam' - $ref: '#/parameters/includeSourceParam' - $ref: '#/parameters/fieldsParam' @@ -183,7 +183,7 @@ paths: '200': description: Successful response schema: - $ref: '#/definitions/IGNodeAssociationPaging' + $ref: '#/definitions/FilePlanComponentAssociationPaging' '401': description: If authentication fails '403': @@ -229,7 +229,7 @@ paths: 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: ```JSON @@ -306,7 +306,7 @@ paths: } ``` 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. 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. - **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 body creates two folders inside the specified **nodeId**, if the **nodeId** identifies 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: - + ```JSON { "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. required: false type: boolean - - $ref: '#/parameters/IGNodeEntryIncludeParam' + - $ref: '#/parameters/FilePlanComponentEntryIncludeParam' - $ref: '#/parameters/fieldsParam' - in: body name: nodeBodyCreate @@ -395,7 +395,7 @@ paths: '201': description: Successful response schema: - $ref: '#/definitions/IGNodeEntry' + $ref: '#/definitions/FilePlanComponentEntry' '400': description: | Invalid parameter: **fileplanComponentId** is not a valid format or **nodeBodyCreate** is invalid @@ -599,11 +599,11 @@ paths: $ref: '#/definitions/Error' '/records/{recordId}/file': post: - tags: + tags: - records summary: File a record 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** 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. 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 - parameters: + parameters: - $ref: '#/parameters/recordIdParam' - - $ref: '#/parameters/IGNodeEntryIncludeParam' + - $ref: '#/parameters/FilePlanComponentEntryIncludeParam' - $ref: '#/parameters/fieldsParam' - in: body name: nodeBodyFile @@ -633,7 +633,7 @@ paths: '200': description: Successful response schema: - $ref: '#/definitions/IGNodeEntry' + $ref: '#/definitions/FilePlanComponentEntry' '400': description: | Invalid parameter: **recordIdParam** or **targetParentId** is not a valid format, @@ -654,12 +654,12 @@ paths: $ref: '#/definitions/Error' '/files/{fileId}/declare': post: - tags: + tags: - files summary: Declare as record description: Declares the file **fileId** in the unfiled record container. operationId: declareRecord - parameters: + parameters: - name: fileId in: path 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. type: boolean default: false - - $ref: '#/parameters/IGNodeEntryIncludeParam' + - $ref: '#/parameters/FilePlanComponentEntryIncludeParam' - $ref: '#/parameters/fieldsParam' consumes: - application/json @@ -680,7 +680,7 @@ paths: '200': description: Successful response schema: - $ref: '#/definitions/IGNodeEntry' + $ref: '#/definitions/FilePlanComponentEntry' '400': description: | Invalid parameter: **fileId** is not a valid format @@ -742,7 +742,7 @@ parameters: information is returned on the node resolved by this path. required: false type: string - IGNodeEntryIncludeParam: + FilePlanComponentEntryIncludeParam: name: include in: query description: | @@ -854,14 +854,14 @@ parameters: type: string format: date-time definitions: - IGNodeEntry: + FilePlanComponentEntry: type: object required: - entry properties: entry: - $ref: '#/definitions/IGNode' - IGNode: + $ref: '#/definitions/FilePlanComponent' + FilePlanComponent: type: object required: - id @@ -932,7 +932,7 @@ definitions: type: string path: $ref: '#/definitions/PathInfo' - IGNodeAssociationPaging: + FilePlanComponentAssociationPaging: type: object properties: list: @@ -943,24 +943,24 @@ definitions: entries: type: array items: - $ref: '#/definitions/IGNodeChildAssociationEntry' + $ref: '#/definitions/FilePlanComponentChildAssociationEntry' source: - $ref: '#/definitions/IGNode' - IGNodeChildAssociationEntry: + $ref: '#/definitions/FilePlanComponent' + FilePlanComponentChildAssociationEntry: type: object required: - entry properties: entry: - $ref: '#/definitions/IGNodeChildAssociation' - IGNodeChildAssociation: + $ref: '#/definitions/FilePlanComponentChildAssociation' + FilePlanComponentChildAssociation: allOf: - - $ref: '#/definitions/IGNode' + - $ref: '#/definitions/FilePlanComponent' - type: object properties: association: $ref: '#/definitions/ChildAssociationInfo' - IGNodeBodyUpdate: + FilePlanComponentBodyUpdate: type: object properties: name: