Bug 35368 - "Add a checkout" shows up twice in online documentation
Summary: "Add a checkout" shows up twice in online documentation
Status: Pushed to stable
Alias: None
Product: Koha
Classification: Unclassified
Component: REST API (show other bugs)
Version: Main
Hardware: All All
: P5 - low trivial
Assignee: Katrin Fischer
QA Contact:
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2023-11-20 09:32 UTC by Katrin Fischer
Modified: 2024-02-01 16:19 UTC (History)
2 users (show)

See Also:
Change sponsored?: ---
Patch complexity: Trivial patch
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
24.05.00,23.11.03
Circulation function:


Attachments
Bug 35368: Add public to "Add a new checkout" in API documentation (1.47 KB, patch)
2024-01-13 15:23 UTC, Katrin Fischer
Details | Diff | Splinter Review
Bug 35368: Add public to "Add a new checkout" in API documentation (1.56 KB, patch)
2024-01-24 16:41 UTC, Matt Blenkinsop
Details | Diff | Splinter Review
Bug 35368: Add public to "Add a new checkout" in API documentation (1.59 KB, patch)
2024-01-26 19:04 UTC, Tomás Cohen Arazi (tcohen)
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Katrin Fischer 2023-11-20 09:32:38 UTC
https://api.koha-community.org/Development.html#tag/checkouts/operation/addCheckout

https://api.koha-community.org/Development.html#tag/checkouts/operation/addCheckoutPublic

I think we should add (public) to one of the headings.

... also should we maybe have it read: "check out an item"?
Comment 1 Katrin Fischer 2024-01-13 15:23:13 UTC
Created attachment 161013 [details] [review]
Bug 35368: Add public to "Add a new checkout" in API documentation

Without this patch the "Add a new checkout" label showed
up twice in the Checkouts section of the API documentation.
This adds (public) to the end of one, to make it possible
to distinguish them.

To test (ON YOUR HOST MACHINE):
1. Run:
   $ cd api/v1/swagger
   $ docker run --rm -v $(pwd):/api --workdir /api redocly/cli \
           build-docs swagger.yaml --output index.html
2. Open the generated index.html in your browser
3. Verify doubled up headings
4. Apply patch
5. Re-run docker command form 1.
6. Verify there are now 2 different labels and "(public)" is on the
   right one.

Note: if you have wrong permissions on the file, chown it to your
own user to open it in the browser.
Comment 2 Matt Blenkinsop 2024-01-24 16:41:07 UTC
Created attachment 161353 [details] [review]
Bug 35368: Add public to "Add a new checkout" in API documentation

Without this patch the "Add a new checkout" label showed
up twice in the Checkouts section of the API documentation.
This adds (public) to the end of one, to make it possible
to distinguish them.

To test (ON YOUR HOST MACHINE):
1. Run:
   $ cd api/v1/swagger
   $ docker run --rm -v $(pwd):/api --workdir /api redocly/cli \
           build-docs swagger.yaml --output index.html
2. Open the generated index.html in your browser
3. Verify doubled up headings
4. Apply patch
5. Re-run docker command form 1.
6. Verify there are now 2 different labels and "(public)" is on the
   right one.

Note: if you have wrong permissions on the file, chown it to your
own user to open it in the browser.

Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
Comment 3 Tomás Cohen Arazi (tcohen) 2024-01-26 19:04:26 UTC
Created attachment 161561 [details] [review]
Bug 35368: Add public to "Add a new checkout" in API documentation

Without this patch the "Add a new checkout" label showed
up twice in the Checkouts section of the API documentation.
This adds (public) to the end of one, to make it possible
to distinguish them.

To test (ON YOUR HOST MACHINE):
1. Run:
   $ cd api/v1/swagger
   $ docker run --rm -v $(pwd):/api --workdir /api redocly/cli \
           build-docs swagger.yaml --output index.html
2. Open the generated index.html in your browser
3. Verify doubled up headings
4. Apply patch
5. Re-run docker command form 1.
6. Verify there are now 2 different labels and "(public)" is on the
   right one.

Note: if you have wrong permissions on the file, chown it to your
own user to open it in the browser.

Signed-off-by: Matt Blenkinsop <matt.blenkinsop@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Comment 4 Katrin Fischer 2024-01-30 16:50:10 UTC
Pushed for 24.05!

Well done everyone, thank you!
Comment 5 Fridolin Somers 2024-02-01 16:19:22 UTC
Pushed to 23.11.x for 23.11.03