FUS-5906 #4

DavidDwyer87 · 2024-11-13T05:33:13Z

https://lucidworks.atlassian.net/browse/FUS-5906

updates to jira asciidoc
add attachment support the configuration

jira/jira-v1.json

jira/jira-v1.asciidoc

mcondo · 2024-11-13T19:02:17Z

jira/jira-v1.asciidoc

+
+* `${LW_BATCH_SIZE}` - This variable is used to set the `limit` query parameter, which controls the number of results that are returned in the response for both `blogpost` and `pages`.
+
+* `${LW_INDEX_START}` - This variable is used to set the `start` query parameter, which is used to traverse the pagination. Jira pagination is zero-index-based. This means the first page number is 0.


Change to: Add Used with pagination feature. This variable is used to set the startAt query parameter, which is used to traverse the pagination. Jira pagination is zero-index-based. This means the first page number is 0.

jira/jira-v1.asciidoc

mcondo · 2024-11-13T19:26:23Z

jira/jira-v1.asciidoc

+
+== Pagination information
+
+This recipe is configured to use pagination by batch size. 


This recipe is configured to use pagination by batch size. Needs to configure Query Params, and the property 'Pagination By BatchSize'
Query Params:

maxResults=${LW_BATCH_SIZE}, where ${LW_BATCH_SIZE} is a variable

startAt=${LW_INDEX_START}, where ${LW_INDEX_START} is a variable

Configure the 'Pagination By BatchSize' properties

IndexStart: The starting point. Set to 0 because the Atlassian pagination is zero-index-base. From the queries above, it replaces variable ${LW_INDEX_START}, the plugin internally increases the value of the indexStart ensuring each page is requested with an updated start-point.

BatchSize: The number of elements to retrieve. Set to 50 by default. From the queries above, it replaces variable ${LW_BATCH_SIZE}

Stop Condition Key: Reference the “key” in the response, that needs to be met in order to stop the pagination. To paginate issues, it must be “issues”, to paginate projects it must be 'values'

Stop Condition Value: Reference the “value” in the response, that needs to be met in order to stop the pagination. For the jira config, to stop pagination the list of objects retrieved must be empty, then the stop condition should be []

mcondo · 2024-11-13T19:35:31Z

jira/jira-v1.json

+                        "childResponseMapping": {
+                            "childDataId": "self",
+                            "binaryResponse": true,
+                            "parentNestedData": "issues[*].fields.attachment[*]",


Need to change to `"parentNestedData": "fields.attachment[*]", otherwise the attachment metadata list will not be extracted

jira/jira-v1.json

jira/jira-v1.asciidoc

mcondo · 2024-11-18T17:16:13Z

jira/jira-v1.asciidoc

+|Root Request |/rest/api/2/search|GET    |fields=assignee,issuetype,priority,project,reporter,status,summary,updated,attachment&startAt=1&maxResults=50|Returns all jira issues. Each issue contains its list of attachments metadata
+|Child Request |/rest/api/2/issue/${LW_PARENT_DATA_KEY}/comment|GET|startAt=0&maxResult=50|Returns all comments. The request requires the 'issue Id'. Internally, the plugin replaces the variable ${LW_PARENT_DATA_KEY} with the 'issue id', which value is extracted from the 'issue object' (root object) by setting the parentDataKey property.
+|Child Request |/rest/api/2/issue/${LW_PARENT_DATA_KEY}/worklog | GET |startAt=0&maxResult=50 |Returns all worklogs. The request requires the 'issue Id'. Internally, the plugin replaces the variable ${LW_PARENT_DATA_KEY} with the 'issue id', which value is extracted from the 'issue object' (root object) by setting the parentDataKey property.
+|Child Request |/rest/api/2/attachment/content/${LW_PARENT_DATA_KEY}|GET|-|Use root response containing attachment Id's to retrieve attachments. The following jsonpath is used to retrieve the attachment id's `fields.attachment[*]` 


@DavidDwyer87 I suggest to change description to: Download the attachment content. The request requires the 'attachment Id'. Internally, the plugin replaces the variable ${LW_PARENT_DATA_KEY} with the 'attachment id', which value is extracted in two steps: step-1) setting prop parentNestedDataPath= fields.attachment[*] to extract the attachment metadata list from the issue object step-2) setting prop parentDataKey=id to extract the 'id' from each attachment metadata. The download request will be performed per each attachment metadata found

@DavidDwyer87 this explanation is to describe how the /rest/api/2/attachment/content/${LW_PARENT_DATA_KEY} will download the attachments

jira/jira-v1.asciidoc

jira/jira-v1.json

mcondo · 2024-11-19T22:06:06Z

jira/jira-v1.asciidoc

+
+The Jira REST configuration variables used are:
+
+* `${LW_BATCH_SIZE}` - Used with pagination feature. This variable is used to set the `limit` query parameter, which controls the number of results that are returned in the response for both `blogpost` and `pages`.


@DavidDwyer87 this description is referencing confluence stuff (limit, blogspost, pages). Update to reference to Jira ->

Used with pagination feature. This variable is used to set the maxResults query parameter, which controls the number of results that are returned in the response for projects, issues, comments, worklogs

mcondo · 2024-11-19T22:07:55Z

jira/jira-v1.asciidoc

+
+* `${LW_INDEX_START}` - Used with pagination feature. This variable is used to set the startAt query parameter, which is used to traverse the pagination. Jira pagination is zero-index-based. This means the first page number is 0.
+
+* `${LW_PARENT_DATA_KEY}` - Used with pagination feature. This variable is used to set the maxResults query parameter, which controls the number of results that are returned in the response for projects, issues, comments, worklogs


It is not describing the variable correctly, it should be ->

Used with Child Request Configuration. This variable is replaced with the 'id' extracted from root object, by setting the property parentDataKey. The jira use case indicates this variable can be added the URL to execute a GET request to retrieve comments, worklogs and attachments from issues

mcondo · 2024-11-19T22:09:05Z

jira/jira-v1.asciidoc

+|=======================
+|Request type|Endpoint|HTTP operation |Query parameter |Description 
+
+|Root Request |/rest/api/2/search|GET    |fields=assignee,issuetype,priority,project,reporter,status,summary,updated,attachment&startAt=1&maxResults=50|Returns all jira issues. Each issue contains its list of attachments metadata


@DavidDwyer87 description for Project Root Request is missing

mcondo · 2024-11-19T22:20:44Z

sample-jira-setup.json

@@ -0,0 +1,114 @@
+{


Why there are two json files jira/jira-v1.json and sample-jira-setup.json? the second one does not configure the projects endpoint

mcondo · 2024-11-19T22:27:41Z

jira/jira-v1.json

+                        ]
+                    },
+                    "rootResponseMapping": {
+                        "dataId": "self",


@DavidDwyer87 I saw the dataId for project was updated to use key, maybe that should be made the same for issues?, also use key here instead of self?

DavidDwyer87 added 4 commits November 12, 2024 16:42

update to the datasoruce config template

5a45d55

add attachment and change pipeline

95c6385

doc update

9999888

update endpoint description

19a0427

DavidDwyer87 requested a review from mcondo November 13, 2024 05:33

mcondo requested changes Nov 13, 2024

View reviewed changes

DavidDwyer87 added 16 commits November 14, 2024 09:17

add issues to the list of capabilities

8a4b7d0

password instruction

5bcee3c

grammer correction

4e4b20b

updates to pagination

b146d58

value correction

0d559a9

add a pipeline note

d9f44b1

correction to rest config

841aab9

re-arrange table

e812e02

update term description

875decc

add example of jasonpath

6a68567

updated to child request

fdf1923

update root request description

b2e751c

worklogs update description

6461cf5

comments description update

0b4bbce

update root request description

c3c7f77

indexing project as solr docs

d443453

mcondo requested changes Nov 18, 2024

View reviewed changes

jira/jira-v1.asciidoc Show resolved Hide resolved

jira/jira-v1.asciidoc Outdated Show resolved Hide resolved

jira/jira-v1.asciidoc Outdated Show resolved Hide resolved

jira/jira-v1.asciidoc Show resolved Hide resolved

mcondo requested changes Nov 18, 2024

View reviewed changes

DavidDwyer87 added 5 commits November 19, 2024 15:46

correct formatting issue

486c944

update varialbe description

fc48d41

update variables

f7b37d7

correction to formatting

b4ea49c

Parent nested data path

fbc3ba9

mcondo requested changes Nov 19, 2024

View reviewed changes

mcondo reviewed Nov 19, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FUS-5906 #4

FUS-5906 #4

DavidDwyer87 commented Nov 13, 2024

mcondo Nov 13, 2024

mcondo Nov 13, 2024

mcondo Nov 13, 2024

mcondo Nov 18, 2024 •

edited

Loading

DavidDwyer87 Nov 19, 2024

mcondo Nov 19, 2024

mcondo Nov 19, 2024

mcondo Nov 19, 2024

mcondo Nov 19, 2024

mcondo Nov 19, 2024

mcondo Nov 19, 2024


		* `${LW_BATCH_SIZE}` - This variable is used to set the `limit` query parameter, which controls the number of results that are returned in the response for both `blogpost` and `pages`.

		* `${LW_INDEX_START}` - This variable is used to set the `start` query parameter, which is used to traverse the pagination. Jira pagination is zero-index-based. This means the first page number is 0.


		== Pagination information

		This recipe is configured to use pagination by batch size.


		The Jira REST configuration variables used are:

		* `${LW_BATCH_SIZE}` - Used with pagination feature. This variable is used to set the `limit` query parameter, which controls the number of results that are returned in the response for both `blogpost` and `pages`.


		* `${LW_INDEX_START}` - Used with pagination feature. This variable is used to set the startAt query parameter, which is used to traverse the pagination. Jira pagination is zero-index-based. This means the first page number is 0.

		* `${LW_PARENT_DATA_KEY}` - Used with pagination feature. This variable is used to set the maxResults query parameter, which controls the number of results that are returned in the response for projects, issues, comments, worklogs

FUS-5906 #4

Are you sure you want to change the base?

FUS-5906 #4

Conversation

DavidDwyer87 commented Nov 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcondo Nov 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mcondo Nov 18, 2024 •

edited

Loading