Skip to content

Commit 2c47ddc

Browse files
committed
docs: add documentation for authentication
1 parent 912aa88 commit 2c47ddc

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

docs/changelog.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ category: Administration
1515
* docs: provide documentation for REST API
1616
* docs: improve REST API documentation
1717
* docs: provide example payload in documentation
18+
* docs: add documentation for authentication
1819

1920
### [24.06.0] - 2024-06-30
2021

docs/rest-api.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,11 @@ Please make sure you have updates Multiple Subtasks for Jira to the latest versi
1313
* Table of Contents
1414
{:toc}
1515

16+
### Authentication
17+
18+
The REST API provided by Multiple Subtasks for Jira requires you to be authenticated as a valid and licensed user of Jira.
19+
Please see the documentation on [Basic Authentication](https://developer.atlassian.com/server/jira/platform/basic-authentication/) or [Personal Access Tokens](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html) for different ways to identify as a valid user.
20+
1621
### Create Subtasks `POST /subtasks/{issueKey}`
1722

1823
Request URL: /rest/multiple-subtasks/1.0/subtasks/{issueKey}
@@ -34,24 +39,24 @@ Create the subtasks from the payload for the given `issueKey`.
3439

3540
This is an example for the payload in the request in order to create two subtasks:
3641

37-
- Hallo World
42+
- Hello World
3843
fixVersion: unknown
39-
- Hallo Moon
44+
- Hello Moon
4045
label: rest-api-demo
4146

4247
The plugin successfully creates two subtasks and responds with the following JSON:
4348

4449
[
4550
{
4651
"issueKey": "YEAH-43",
47-
"issueSummary": "Hallo World",
52+
"issueSummary": "Hello World",
4853
"warnings": [
4954
"Invalid fixVersion: unknown"
5055
]
5156
},
5257
{
5358
"issueKey": "YEAH-44",
54-
"issueSummary": "Hallo Moon",
59+
"issueSummary": "Hello Moon",
5560
"warnings": []
5661
}
5762
]

0 commit comments

Comments
 (0)