Marmelator/persistence-service
1
0
Fork 0
Code Issues Pull Requests 17 Actions Packages Projects Releases 1.1k Wiki Activity

RED-9114 - RedactManager API Specs for BASF (Cherry-picked merge-commit... #505

Merged
kresnadi.budisantoso merged 4 commits from RED-9114-apispec into master 2024-06-03 14:54:11 +02:00
Conversation 34 Commits 4 Files Changed 2 +4076 -135
kresnadi.budisantoso commented 2024-05-27 11:54:45 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

RED-9114 - RedactManager API Specs for BASF (Cherry-picked merge-commit 0ecd23304 from release/2.349.x)

Attention: This will likely conflict with MR 485 by @kilian.schuettler1 or cause that MR to conflict, depending on what gets merged first.

RED-9114 - RedactManager API Specs for BASF (Cherry-picked merge-commit 0ecd23304 from release/2.349.x) Attention: This will likely conflict with [MR 485](https://gitlab.knecon.com/redactmanager/persistence-service/-/merge_requests/485) by @kilian.schuettler1 or cause that MR to conflict, depending on what gets merged first.
kresnadi.budisantoso commented 2024-05-27 11:54:45 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

requested review from @kilian.schuettler1

requested review from @kilian.schuettler1
dominique.eiflaender1 (Migrated from gitlab.knecon.com) approved these changes 2024-05-27 11:54:45 +02:00
kilian.schuettler1 commented 2024-05-28 17:22:27 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Needs a bit more formatting imo.

Also i'd simplify, as the text seems convoluted to me.

Maybe more like:

This endpoint allows you to define the content and initiate the creation of a download package for all files within a dossier.

Request

  • Specify the files and reports to be included in the download package.
  • Start the process of creating the download package.

Response

Includes an identifier for the download. Use this identifier to query the status of the download package preparation and download the file once it is available.

Needs a bit more formatting imo. Also i'd simplify, as the text seems convoluted to me. Maybe more like: This endpoint allows you to define the content and initiate the creation of a download package for all files within a dossier. #### Request * Specify the files and reports to be included in the download package. * Start the process of creating the download package. #### Response Includes an identifier for the download. Use this identifier to query the status of the download package preparation and download the file once it is available.
kilian.schuettler1 commented 2024-05-28 17:25:04 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

specified -> specific

specified -\> specific
kilian.schuettler1 commented 2024-05-28 17:25:41 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

This endpoint facilitates to retrieve -> Use this endpoint to retrieve

This endpoint facilitates to retrieve -\> Use this endpoint to retrieve
kilian.schuettler1 commented 2024-05-28 17:29:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

The description of the response format seems unnecessary to me, shouldn't this just explain the functionality more like:

The response contains the status of each download.

A download may be queued, generating, finished or failed. When it is finished, the download package may be obtained using the download endpoint

The description of the response format seems unnecessary to me, shouldn't this just explain the functionality more like: The response contains the status of each download. A download may be queued, generating, finished or failed. When it is finished, the download package may be obtained using the download endpoint
kilian.schuettler1 commented 2024-05-28 17:32:34 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Needs a bit more formatting imo.

Needs a bit more formatting imo.
kilian.schuettler1 commented 2024-05-28 17:32:34 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Needs a bit more formatting imo.

Needs a bit more formatting imo.
kilian.schuettler1 commented 2024-05-28 17:32:35 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Same as for dossier download endpoint

Same as for dossier download endpoint
kilian.schuettler1 commented 2024-05-28 17:32:35 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Same here as for dossier download

Same here as for dossier download
kilian.schuettler1 commented 2024-05-28 17:32:35 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Shouldn't this be called the FileComponents of each files in a dossier?

RSS is an old name that imo should not be used anymore, right?

Shouldn't this be called the FileComponents of each files in a dossier? RSS is an old name that imo should not be used anymore, right?
kilian.schuettler1 commented 2024-05-28 17:32:35 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Same as bulk endpoint

Same as bulk endpoint
kilian.schuettler1 commented 2024-05-28 17:32:35 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Use this endpoint to remove a download

Use this endpoint to remove a download
kilian.schuettler1 commented 2024-05-28 17:32:35 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

This endpoint facilitates to retrieve -> Use this endpoint to retrieve

This endpoint facilitates to retrieve -\> Use this endpoint to retrieve
kresnadi.budisantoso commented 2024-05-28 18:57:59 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_572_572)
kresnadi.budisantoso commented 2024-05-28 18:57:59 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_977_998)
kresnadi.budisantoso commented 2024-05-28 18:57:59 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_1017_1038)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_777_784)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_859_873)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_975_996)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_1044_1068)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_1074_1098)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 2 of the diff

changed this line in [version 2 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88#55258c946dbcca62ed804b66a6c6e3e62e82b98d_1138_1162)
kresnadi.budisantoso commented 2024-05-28 18:58:00 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

added 2 commits

  • 883cf2fe - RedactManager API Specs for BASF - Fixed missing property, fields and examples
  • 24ca3afd - RedactManager API Specs for BASF - Improved descriptions

Compare with previous version

added 2 commits <ul><li>883cf2fe - RedactManager API Specs for BASF - Fixed missing property, fields and examples</li><li>24ca3afd - RedactManager API Specs for BASF - Improved descriptions</li></ul> [Compare with previous version](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43671&start_sha=3f308ebfed1e72266a7527eb7ce538be9ef2da88)
kresnadi.budisantoso commented 2024-05-28 19:04:42 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 3 of the diff

changed this line in [version 3 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43673&start_sha=24ca3afd32f31708578a5244f26ad7cb3212cd0c#55258c946dbcca62ed804b66a6c6e3e62e82b98d_282_282)
kresnadi.budisantoso commented 2024-05-28 19:04:43 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

changed this line in version 3 of the diff

changed this line in [version 3 of the diff](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43673&start_sha=24ca3afd32f31708578a5244f26ad7cb3212cd0c#55258c946dbcca62ed804b66a6c6e3e62e82b98d_313_319)
kresnadi.budisantoso commented 2024-05-28 19:04:43 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

added 1 commit

  • d1d3e8df - RedactManager API Specs for BASF - Improved descriptions

Compare with previous version

added 1 commit <ul><li>d1d3e8df - RedactManager API Specs for BASF - Improved descriptions</li></ul> [Compare with previous version](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=43673&start_sha=24ca3afd32f31708578a5244f26ad7cb3212cd0c)
kresnadi.budisantoso commented 2024-05-28 19:04:54 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

resolved all threads

resolved all threads
kresnadi.budisantoso commented 2024-05-28 19:08:03 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

I have improved the descriptions and cherry-picked the fixes I have made for the release/2.349.x branch.

I have improved the descriptions and cherry-picked the fixes I have made for the release/2.349.x branch.
kresnadi.budisantoso commented 2024-06-03 12:03:17 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

added 11 commits

  • d1d3e8df...9e70d9e1 - 8 commits from branch master
  • 00a1cadb - RED-9114 - RedactManager API Specs for BASF (Cherry-picked merge-commit...
  • f3758fb0 - RedactManager API Specs for BASF - Fixed missing property, fields and examples
  • 55922a85 - RedactManager API Specs for BASF - Improved descriptions

Compare with previous version

added 11 commits <ul><li>d1d3e8df...9e70d9e1 - 8 commits from branch <code>master</code></li><li>00a1cadb - RED-9114 - RedactManager API Specs for BASF (Cherry-picked merge-commit...</li><li>f3758fb0 - RedactManager API Specs for BASF - Fixed missing property, fields and examples</li><li>55922a85 - RedactManager API Specs for BASF - Improved descriptions</li></ul> [Compare with previous version](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=44004&start_sha=d1d3e8dfca2241c5c6f66eac36e87ddd17affc27)
kresnadi.budisantoso commented 2024-06-03 12:04:09 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

Just rebased to master and solved merge conflicts.

Just rebased to master and solved merge conflicts.
kresnadi.budisantoso commented 2024-06-03 14:41:30 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

added 1 commit

  • 16222286 - Fixed missing path parameter reference and removed wrong endpoint tags

Compare with previous version

added 1 commit <ul><li>16222286 - Fixed missing path parameter reference and removed wrong endpoint tags</li></ul> [Compare with previous version](/redactmanager/persistence-service/-/merge_requests/505/diffs?diff_id=44058&start_sha=55922a85e86eb1617e4135b7b4e15d1367b73b79)
dominique.eiflaender1 commented 2024-06-03 14:46:53 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

approved this merge request

approved this merge request
dominique.eiflaender1 (Migrated from gitlab.knecon.com) scheduled this pull request to auto merge when all checks succeed 2024-06-03 14:46:58 +02:00
dominique.eiflaender1 (Migrated from gitlab.knecon.com) merged commit b66e436058 into master 2024-06-03 14:54:11 +02:00
dominique.eiflaender1 commented 2024-06-03 14:54:12 +02:00 (Migrated from gitlab.knecon.com)
Copy Link

mentioned in commit b66e436058

mentioned in commit b66e436058fd1097d1290385c8680fe950bcbde6
Sign in to join this conversation.
Reviewers
No Reviewers
dominique.eiflaender1
Labels
Clear labels
renovate
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
Marmelator
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Marmelator/persistence-service#505
No description provided.
Delete Branch "RED-9114-apispec"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?