Bug 35219 - ERM usage endpoints not showing up in documentation
Summary: ERM usage endpoints not showing up in documentation
Status: RESOLVED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: REST API (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low blocker (vote)
Assignee: Matt Blenkinsop
QA Contact: Katrin Fischer
URL:
Keywords: rel_23_11_candidate
Depends on: 34587
Blocks:
  Show dependency treegraph
 
Reported: 2023-11-01 18:02 UTC by Tomás Cohen Arazi
Modified: 2023-11-10 07:03 UTC (History)
3 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Small patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
23.11.00


Attachments
Bug 35219: Fix ERM usage endpoints to show in docs (13.25 KB, patch)
2023-11-02 14:04 UTC, Matt Blenkinsop
Details | Diff | Splinter Review
Bug 35219: Fix ERM usage endpoints to show in docs (13.28 KB, patch)
2023-11-03 12:34 UTC, Owen Leonard
Details | Diff | Splinter Review
Bug 35219: Fix ERM usage endpoints to show in docs (13.33 KB, patch)
2023-11-04 18:15 UTC, Katrin Fischer
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Tomás Cohen Arazi 2023-11-01 18:02:55 UTC
Due to the lack of pointers from swagger.yaml to the tags used on the feature's endpoints, there's no mention to them in the docs [1]

Before doing it, please beware the tags should all be scoped with the `erm_` prefix to avoid future problems.


[1] https://api.koha-community.org/Development.html
Comment 1 Matt Blenkinsop 2023-11-02 14:04:20 UTC
Created attachment 158263 [details] [review]
Bug 35219: Fix ERM usage endpoints to show in docs

This patch fixes the tags and also adds the tags to the swagger.yaml file to allow the endpoints to be documented correctly.

One endpoint has also been deleted as it is no longer required.

Test plan:
Check the attached files to see that all tags are now prefixed with 'erm_' and that the swagger file now includes an entry for all of these files
Comment 2 Owen Leonard 2023-11-03 12:34:05 UTC
Created attachment 158333 [details] [review]
Bug 35219: Fix ERM usage endpoints to show in docs

This patch fixes the tags and also adds the tags to the swagger.yaml
file to allow the endpoints to be documented correctly.

One endpoint has also been deleted as it is no longer required.

Test plan:
Check the attached files to see that all tags are now prefixed with
'erm_' and that the swagger file now includes an entry for all of these
files

Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Comment 3 Katrin Fischer 2023-11-04 18:15:03 UTC
Created attachment 158395 [details] [review]
Bug 35219: Fix ERM usage endpoints to show in docs

This patch fixes the tags and also adds the tags to the swagger.yaml
file to allow the endpoints to be documented correctly.

One endpoint has also been deleted as it is no longer required.

Test plan:
Check the attached files to see that all tags are now prefixed with
'erm_' and that the swagger file now includes an entry for all of these
files

Signed-off-by: Owen Leonard <oleonard@myacpl.org>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Comment 4 Tomás Cohen Arazi 2023-11-06 11:40:55 UTC
Pushed to master for 23.11.

Nice work everyone, thanks!
Comment 5 Fridolin Somers 2023-11-10 07:03:11 UTC
Depends on Bug 34587 not in 23.05.x