From 7d8009e9c6d97225326a328ac4c3547370dc625f Mon Sep 17 00:00:00 2001
From: DmitriyLewen <91113035+DmitriyLewen@users.noreply.github.com>
Date: Tue, 22 Mar 2022 18:20:26 +0600
Subject: [PATCH 1/3] docs(README): add info to jira output
Added info about using 'unknowns' field in jira output
---
README.md | 38 +++++++++++++++++++++++++++++++++++++-
1 file changed, 37 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index eec6fe86..95cb6059 100644
--- a/README.md
+++ b/README.md
@@ -290,7 +290,43 @@ Key | Description | Possible Values
For Jira you can also specify custom fields that will be populated with values.
Use the `unknowns` parameter in cfg.yaml for custom fields.
-Under the `unknowns` parameter, specify the list of fields names to provide value for.
+Under the `unknowns` parameter, specify the list of fields **names** to provide value for.
+You can get field name from [Jira REST API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-get). `Name` field can contain spaces.
+
+ For example:
+
+ Jira REST API response
+
+ ```
+ ...
+ "id": "customfield_10014",
+ "key": "customfield_10014",
+ "name": "Epic Link",
+ "untranslatedName": "Epic Link",
+ "custom": true,
+ "orderable": true,
+ "navigable": true,
+ "searchable": true,
+ "clauseNames": [
+ "cf[10014]",
+ "Epic Link"
+ ],
+ "schema": {
+ "type": "any",
+ "custom": "com.pyxis.greenhopper.jira:gh-epic-link",
+ "customId": 10014
+ }
+ },
+ ...
+ ```
+
+ Get field name from Jira UI
+
+1. Move to your jira.
+2. Navigate to **Settings**() > **Issues** > **Custom fields** under the Fields section:
+
+3. Click on the required field.
+
+
+
+4. Get value from **Name** field.
+
+
+
- Jira REST API response
+ Get field name from Jira REST API
+
+1. Get all Jira fields [according to instructions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-get)
+2. Find needed field:
+
```
...
"id": "customfield_10014",
@@ -319,8 +336,11 @@ You can get field name from [Jira REST API](https://developer.atlassian.com/clou
},
...
```
-
-
+3. Get value from **Name** field.
+
+