Attachment 161353 Details for Bug 35368 – Bug 35368: Add public to "Add a new checkout" in API documentation

[patch] Bug 35368: Add public to "Add a new checkout" in API documentation

Bug-35368-Add-public-to-Add-a-new-checkout-in-API-.patch (text/plain), 1.56 KB, created by Matt Blenkinsop on 2024-01-24 16:41:07 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Matt Blenkinsop

Created: 2024-01-24 16:41:07 UTC

Size: 1.56 KB

patch

obsolete

>From 49f85932f42382999ca162fc9f77434ca8659ae9 Mon Sep 17 00:00:00 2001
>From: Katrin Fischer <katrin.fischer.83@web.de>
>Date: Fri, 12 Jan 2024 23:51:14 +0000
>Subject: [PATCH] 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>
>---
> api/v1/swagger/paths/public_patrons.yaml | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
>diff --git a/api/v1/swagger/paths/public_patrons.yaml b/api/v1/swagger/paths/public_patrons.yaml
>index 596a34eb2f4..cda6d2a342a 100644
>--- a/api/v1/swagger/paths/public_patrons.yaml
>+++ b/api/v1/swagger/paths/public_patrons.yaml
>@@ -69,7 +69,7 @@
>     tags:
>       - checkouts
>       - patrons
>-    summary: Add a new checkout
>+    summary: Add a new checkout (public)
>     parameters:
>       - $ref: "../swagger.yaml#/parameters/patron_id_pp"
>       - name: body
>-- 
>2.37.1 (Apple Git-137.1)

Actions: View | Diff | Splinter Review

Attachments on bug 35368: 161013 | 161353 | 161561