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.

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

FUS-5906: Provide Jira Recipe and documentation #4

Merged
merged 37 commits into from
Nov 20, 2024
Merged

FUS-5906: Provide Jira Recipe and documentation #4

merged 37 commits into from
Nov 20, 2024

Conversation

DavidDwyer87
Copy link
Collaborator

@DavidDwyer87 DavidDwyer87 commented Nov 13, 2024

  • updates to jira asciidoc
  • add attachment support the configuration

@DavidDwyer87 DavidDwyer87 requested a review from mcondo November 13, 2024 05:33
jira/jira-v1.json Outdated Show resolved Hide resolved
jira/jira-v1.json Show resolved Hide resolved
jira/jira-v1.asciidoc Show resolved Hide resolved
jira/jira-v1.asciidoc Show resolved Hide resolved
jira/jira-v1.asciidoc Outdated Show resolved Hide resolved

* `${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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved

== Pagination information

This recipe is configured to use pagination by batch size.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
  1. 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 []

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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

jira/jira-v1.json Show resolved Hide resolved
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 Outdated Show resolved Hide resolved
jira/jira-v1.asciidoc Show resolved Hide resolved
jira/jira-v1.asciidoc Show resolved Hide resolved
jira/jira-v1.asciidoc Outdated Show resolved Hide resolved
jira/jira-v1.asciidoc Show resolved Hide resolved
jira/jira-v1.json Outdated 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
sample-jira-setup.json Outdated Show resolved Hide resolved
jira/jira-v1.json Outdated Show resolved Hide resolved
@mcondo mcondo changed the title FUS-5906 FUS-5906: Provide Jira Recipe and documentation Nov 20, 2024
jira/jira-v1.asciidoc Outdated Show resolved Hide resolved
jira/jira-v1.asciidoc Outdated Show resolved Hide resolved
jira/jira-v1.asciidoc Outdated Show resolved Hide resolved
@mcondo mcondo merged commit 372fec7 into main Nov 20, 2024
@mcondo mcondo deleted the jira branch November 20, 2024 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants