From 15e88cd76ba39c2a1336a0b27f5cfae06ce6ab62 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ji=C5=99=C3=AD=20Hofman?= Date: Tue, 30 Jan 2024 15:53:42 +0100 Subject: [PATCH] Update component descriptions, id description and examples for custom_fields (#17) --- src/appmixer/redmine/bundle.json | 4 ++-- .../redmine/core/IssueCreate/component.json | 17 ++++++++++++++--- .../redmine/core/IssueDelete/component.json | 4 ++-- .../redmine/core/IssueShow/component.json | 4 ++-- .../redmine/core/IssueUpdate/component.json | 17 +++++++++++++---- .../redmine/core/IssuesList/component.json | 2 +- .../redmine/core/ProjectsList/component.json | 2 +- src/appmixer/redmine/openapi.yml | 16 +++++++++------- 8 files changed, 44 insertions(+), 22 deletions(-) diff --git a/src/appmixer/redmine/bundle.json b/src/appmixer/redmine/bundle.json index 3705e207e..17c4d9e61 100644 --- a/src/appmixer/redmine/bundle.json +++ b/src/appmixer/redmine/bundle.json @@ -1,8 +1,8 @@ { "name": "appmixer.redmine", - "version": "1.0.2", + "version": "1.0.3", "changelog": { - "1.0.2": [ + "1.0.3": [ "Redmine" ] } diff --git a/src/appmixer/redmine/core/IssueCreate/component.json b/src/appmixer/redmine/core/IssueCreate/component.json index 5f2231959..4e201dd66 100644 --- a/src/appmixer/redmine/core/IssueCreate/component.json +++ b/src/appmixer/redmine/core/IssueCreate/component.json @@ -2,7 +2,7 @@ "version": "1.0.0", "name": "appmixer.redmine.core.IssueCreate", "author": "Appmixer ", - "description": "

Creates a new issue.

", + "description": "

Create a new issue.

", "private": false, "quota": {}, "inPorts": [ @@ -76,7 +76,18 @@ }, "issue|custom_fields": { "title": "CustomFields", - "type": "string", + "example": [ + { + "value": "1.0.1", + "name": "Affected version", + "id": 1 + }, + { + "value": "Fixed", + "name": "Resolution", + "id": 2 + } + ], "path": "issue.custom_fields", "originalType": "array", "items": { @@ -183,7 +194,7 @@ "type": "textarea", "index": 10, "label": "Issue Custom Fields", - "tooltip": " JSON array. Example: [{}]." + "tooltip": "

Example: [{\"value\":\"1.0.1\",\"name\":\"Affected version\",\"id\":1},{\"value\":\"Fixed\",\"name\":\"Resolution\",\"id\":2}]

." }, "issue|watcher_user_ids": { "type": "textarea", diff --git a/src/appmixer/redmine/core/IssueDelete/component.json b/src/appmixer/redmine/core/IssueDelete/component.json index 55c28493b..52e8f920d 100644 --- a/src/appmixer/redmine/core/IssueDelete/component.json +++ b/src/appmixer/redmine/core/IssueDelete/component.json @@ -2,7 +2,7 @@ "version": "1.0.0", "name": "appmixer.redmine.core.IssueDelete", "author": "Appmixer ", - "description": "

Deletes a issue.

", + "description": "

Delete an issue.

", "private": false, "quota": {}, "inPorts": [ @@ -25,7 +25,7 @@ "type": "text", "index": 0, "label": "Id", - "tooltip": "

ID or identifier of the project/issue/user/timeEntry

" + "tooltip": "

ID or identifier of the issue

" } } } diff --git a/src/appmixer/redmine/core/IssueShow/component.json b/src/appmixer/redmine/core/IssueShow/component.json index d5bdcc7e0..2f23ddc22 100644 --- a/src/appmixer/redmine/core/IssueShow/component.json +++ b/src/appmixer/redmine/core/IssueShow/component.json @@ -2,7 +2,7 @@ "version": "1.0.0", "name": "appmixer.redmine.core.IssueShow", "author": "Appmixer ", - "description": "

Returns the issue of given id or identifier.

", + "description": "

Return the issue of given id or identifier.

", "private": false, "quota": {}, "inPorts": [ @@ -28,7 +28,7 @@ "type": "text", "index": 0, "label": "Id", - "tooltip": "

ID or identifier of the project/issue/user/timeEntry

" + "tooltip": "

ID or identifier of the issue

" }, "include": { "type": "text", diff --git a/src/appmixer/redmine/core/IssueUpdate/component.json b/src/appmixer/redmine/core/IssueUpdate/component.json index 0be3836c5..fa8577489 100644 --- a/src/appmixer/redmine/core/IssueUpdate/component.json +++ b/src/appmixer/redmine/core/IssueUpdate/component.json @@ -2,7 +2,7 @@ "version": "1.0.0", "name": "appmixer.redmine.core.IssueUpdate", "author": "Appmixer ", - "description": "

Updates a issue.

", + "description": "

Update an issue.

", "private": false, "quota": {}, "inPorts": [ @@ -76,7 +76,16 @@ }, "issue|custom_fields": { "title": "CustomFields", - "type": "string", + "example": [ + { + "value": "1.0.2", + "id": 1 + }, + { + "value": "Invalid", + "id": 2 + } + ], "path": "issue.custom_fields", "originalType": "array", "items": { @@ -129,7 +138,7 @@ "type": "text", "index": 0, "label": "Id", - "tooltip": "

ID or identifier of the project/issue/user/timeEntry

" + "tooltip": "

ID or identifier of the issue

" }, "issue|project_id": { "type": "select", @@ -201,7 +210,7 @@ "type": "textarea", "index": 11, "label": "Issue Custom Fields", - "tooltip": " JSON array. Example: [{}]." + "tooltip": "

Example: [{\"value\":\"1.0.2\",\"id\":1},{\"value\":\"Invalid\",\"id\":2}]

." }, "issue|watcher_user_ids": { "type": "textarea", diff --git a/src/appmixer/redmine/core/IssuesList/component.json b/src/appmixer/redmine/core/IssuesList/component.json index 1b1e14115..04fe742b4 100644 --- a/src/appmixer/redmine/core/IssuesList/component.json +++ b/src/appmixer/redmine/core/IssuesList/component.json @@ -2,7 +2,7 @@ "version": "1.0.0", "name": "appmixer.redmine.core.IssuesList", "author": "Appmixer ", - "description": "

Returns a paginated list of issues. By default, it returns open issues only.

", + "description": "

Return a paginated list of issues. By default, it returns open issues only.

", "private": false, "quota": {}, "inPorts": [ diff --git a/src/appmixer/redmine/core/ProjectsList/component.json b/src/appmixer/redmine/core/ProjectsList/component.json index 663d56640..a6b641f2f 100644 --- a/src/appmixer/redmine/core/ProjectsList/component.json +++ b/src/appmixer/redmine/core/ProjectsList/component.json @@ -2,7 +2,7 @@ "version": "1.0.0", "name": "appmixer.redmine.core.ProjectsList", "author": "Appmixer ", - "description": "

Returns all projects (all public projects and private projects where user have access to).

", + "description": "

Return all projects (all public projects and private projects where user have access to).

", "private": false, "quota": {}, "inPorts": [ diff --git a/src/appmixer/redmine/openapi.yml b/src/appmixer/redmine/openapi.yml index adbe3950d..8eada5895 100644 --- a/src/appmixer/redmine/openapi.yml +++ b/src/appmixer/redmine/openapi.yml @@ -86,7 +86,7 @@ tags: paths: /projects.json: get: - description: 'Returns all projects (all public projects and private projects where user have access to).' + description: 'Return all projects (all public projects and private projects where user have access to).' operationId: ProjectsList x-connector-pagination: type: once @@ -127,7 +127,7 @@ paths: $ref: '#/definitions/limit' /issues.json: get: - description: 'Returns a paginated list of issues. By default, it returns open issues only.' + description: 'Return a paginated list of issues. By default, it returns open issues only.' operationId: IssuesList # We want to preserve the `offset` and `limit` parameters in the query string # We loose the `total_count` parameter in the response. @@ -211,7 +211,7 @@ paths: limit: $ref: '#/definitions/limit' post: - description: 'Creates a new issue.' + description: 'Create a new issue.' operationId: IssueCreate x-connector-label: CreateIssue tags: [ Issues ] @@ -279,6 +279,7 @@ paths: custom_fields: title: CustomFields type: array + example: [{"value":"1.0.1","name":"Affected version","id":1},{"value":"Fixed","name":"Resolution","id":2}] items: type: object watcher_user_ids: @@ -304,7 +305,7 @@ paths: $ref: '#/responses/validationError' /issues/{id}.json: get: - description: 'Returns the issue of given id or identifier.' + description: 'Return the issue of given id or identifier.' operationId: IssueShow x-connector-label: GetIssue tags: [ Issues ] @@ -326,7 +327,7 @@ paths: issue: $ref: '#/definitions/issue' put: - description: 'Updates a issue.' + description: 'Update an issue.' operationId: IssueUpdate x-connector-label: UpdateIssue tags: [ Issues ] @@ -386,6 +387,7 @@ paths: custom_fields: title: CustomFields type: array + example: [{"value":"1.0.2","id":1},{"value":"Invalid","id":2}] items: type: object watcher_user_ids: @@ -410,7 +412,7 @@ paths: 422: $ref: '#/responses/validationError' delete: - description: 'Deletes a issue.' + description: 'Delete an issue.' operationId: IssueDelete x-connector-label: DeleteIssue tags: [ Issues ] @@ -426,7 +428,7 @@ parameters: idParam: name: "id" in: path - description: "ID or identifier of the project/issue/user/timeEntry" + description: "ID or identifier of the issue" required: true type: string limitParam: