Update component descriptions, id description and examples for custom…

…_fields (#17)

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"
         ]
     }

src/appmixer/redmine/core/IssueCreate/component.json

@@ -2,7 +2,7 @@
     "version": "1.0.0",
     "name": "appmixer.redmine.core.IssueCreate",
     "author": "Appmixer <[email protected]>",
-    "description": "<p>Creates a new issue.</p>",
+    "description": "<p>Create a new issue.</p>",
     "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": "<p>Example: [{\"value\":\"1.0.1\",\"name\":\"Affected version\",\"id\":1},{\"value\":\"Fixed\",\"name\":\"Resolution\",\"id\":2}]</p>."
                     },
                     "issue|watcher_user_ids": {
                         "type": "textarea",

src/appmixer/redmine/core/IssueDelete/component.json

@@ -2,7 +2,7 @@
     "version": "1.0.0",
     "name": "appmixer.redmine.core.IssueDelete",
     "author": "Appmixer <[email protected]>",
-    "description": "<p>Deletes a issue.</p>",
+    "description": "<p>Delete an issue.</p>",
     "private": false,
     "quota": {},
     "inPorts": [
@@ -25,7 +25,7 @@
                         "type": "text",
                         "index": 0,
                         "label": "Id",
-                        "tooltip": "<p>ID or identifier of the project/issue/user/timeEntry</p>"
+                        "tooltip": "<p>ID or identifier of the issue</p>"
                     }
                 }
             }

src/appmixer/redmine/core/IssueShow/component.json

@@ -2,7 +2,7 @@
     "version": "1.0.0",
     "name": "appmixer.redmine.core.IssueShow",
     "author": "Appmixer <[email protected]>",
-    "description": "<p>Returns the issue of given id or identifier.</p>",
+    "description": "<p>Return the issue of given id or identifier.</p>",
     "private": false,
     "quota": {},
     "inPorts": [
@@ -28,7 +28,7 @@
                         "type": "text",
                         "index": 0,
                         "label": "Id",
-                        "tooltip": "<p>ID or identifier of the project/issue/user/timeEntry</p>"
+                        "tooltip": "<p>ID or identifier of the issue</p>"
                     },
                     "include": {
                         "type": "text",

src/appmixer/redmine/core/IssueUpdate/component.json

@@ -2,7 +2,7 @@
     "version": "1.0.0",
     "name": "appmixer.redmine.core.IssueUpdate",
     "author": "Appmixer <[email protected]>",
-    "description": "<p>Updates a issue.</p>",
+    "description": "<p>Update an issue.</p>",
     "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": "<p>ID or identifier of the project/issue/user/timeEntry</p>"
+                        "tooltip": "<p>ID or identifier of the issue</p>"
                     },
                     "issue|project_id": {
                         "type": "select",
@@ -201,7 +210,7 @@
                         "type": "textarea",
                         "index": 11,
                         "label": "Issue Custom Fields",
-                        "tooltip": " JSON array. Example: [{}]."
+                        "tooltip": "<p>Example: [{\"value\":\"1.0.2\",\"id\":1},{\"value\":\"Invalid\",\"id\":2}]</p>."
                     },
                     "issue|watcher_user_ids": {
                         "type": "textarea",

src/appmixer/redmine/core/IssuesList/component.json

@@ -2,7 +2,7 @@
     "version": "1.0.0",
     "name": "appmixer.redmine.core.IssuesList",
     "author": "Appmixer <[email protected]>",
-    "description": "<p>Returns a paginated list of issues. By default, it returns open issues only.</p>",
+    "description": "<p>Return a paginated list of issues. By default, it returns open issues only.</p>",
     "private": false,
     "quota": {},
     "inPorts": [

src/appmixer/redmine/core/ProjectsList/component.json

@@ -2,7 +2,7 @@
     "version": "1.0.0",
     "name": "appmixer.redmine.core.ProjectsList",
     "author": "Appmixer <[email protected]>",
-    "description": "<p>Returns all projects (all public projects and private projects where user have access to).</p>",
+    "description": "<p>Return all projects (all public projects and private projects where user have access to).</p>",
     "private": false,
     "quota": {},
     "inPorts": [

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: