Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redmine: Update component descriptions, id description and examples for custom_fields #17

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Redmine: Update component descriptions, id description and examples for custom_fields #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/appmixer/redmine/bundle.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "appmixer.redmine",
"version": "1.0.2",
"version": "1.0.3",
"changelog": {
"1.0.2": [
"1.0.3": [
"Redmine"
]
}
Expand Down
17 changes: 14 additions & 3 deletions src/appmixer/redmine/core/IssueCreate/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down
4 changes: 2 additions & 2 deletions src/appmixer/redmine/core/IssueDelete/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -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>"
}
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/appmixer/redmine/core/IssueShow/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -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",
Expand Down
17 changes: 13 additions & 4 deletions src/appmixer/redmine/core/IssueUpdate/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion src/appmixer/redmine/core/IssuesList/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
2 changes: 1 addition & 1 deletion src/appmixer/redmine/core/ProjectsList/component.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand Down
16 changes: 9 additions & 7 deletions src/appmixer/redmine/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 ]
Expand Down Expand Up @@ -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:
Expand All @@ -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 ]
Expand All @@ -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 ]
Expand Down Expand Up @@ -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:
Expand All @@ -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 ]
Expand All @@ -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:
Expand Down
Loading