Bugzilla – Attachment 157893 Details for
Bug 29523
Add a way to prevent embedding objects that should not be allowed
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 29523: (follow-up) Adding documentation to swagger.yaml
Bug-29523-follow-up-Adding-documentation-to-swagge.patch (text/plain), 2.64 KB, created by
Marcel de Rooy
on 2023-10-26 07:32:08 UTC
(
hide
)
Description:
Bug 29523: (follow-up) Adding documentation to swagger.yaml
Filename:
MIME Type:
Creator:
Marcel de Rooy
Created:
2023-10-26 07:32:08 UTC
Size:
2.64 KB
patch
obsolete
>From d14631593a066323d99f00bb8859d4a138469831 Mon Sep 17 00:00:00 2001 >From: Martin Renvoize <martin.renvoize@ptfs-europe.com> >Date: Mon, 23 Oct 2023 16:19:18 +0100 >Subject: [PATCH] Bug 29523: (follow-up) Adding documentation to swagger.yaml >Content-Type: text/plain; charset=utf-8 > >Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> > >Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> >--- > api/v1/swagger/swagger.yaml | 23 +++++++++++++++++++++-- > 1 file changed, 21 insertions(+), 2 deletions(-) > >diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml >index 351f796c56..cdca970837 100644 >--- a/api/v1/swagger/swagger.yaml >+++ b/api/v1/swagger/swagger.yaml >@@ -767,9 +767,20 @@ info: > name: Koha Development Team > url: https://koha-community.org/ > description: | >- ## Introduction >+ ## Background > >- This API is documented in **OpenAPI format**. >+ The API supports two sets of endpoints, one targetted at library staff and the other at at library users. >+ >+ Those endpoints under the `/public` path are aimed at delivering functionality tailored to library users and offer >+ a more restricted set of functions, overrides and data in thier responses for data privacy and library policy >+ reasons. Many of these endpoints do not require authentication for fetching public data, though an authenticated >+ session will expose additional options and allow users to see more data where it is part of their own record. >+ >+ All other endpoints are targetted at the staff interface level and allow for additional functionality and a more >+ unrestricted view of data. These endpoints, however, have a level of redaction built in for resources that the >+ api consumer should not have access to. For example, user data for users who do not belong to the same library >+ or library group of your api user will be reduced to just minimum neccesary for a valid response. Object keys will >+ be consistent for all responses, but their values may be removed depending on access. > > ## Authentication > >@@ -782,6 +793,14 @@ info: > Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled > by system preferences. > >+ ## Authorization >+ >+ The API uses existing user profiles to restrict access to resources based on user permissions and the library the >+ API user is assigned to. This may result, at times, in resources being returned in a redacted form with all keys >+ present but sensative values nulled. >+ >+ We do not yet support OAuth Scopes or the Authorization Code grant flow. >+ > ## Errors > > The API uses standard HTTP status codes to indicate the success or failure >-- >2.30.2
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 29523
:
127886
|
127887
|
127888
|
127889
|
127991
|
127992
|
127993
|
127994
|
128042
|
128043
|
128044
|
128045
|
128046
|
128047
|
128048
|
128688
|
128689
|
128690
|
128691
|
128692
|
128693
|
128694
|
131326
|
131331
|
131332
|
136684
|
136685
|
136686
|
136687
|
136688
|
136689
|
136690
|
136691
|
136692
|
136706
|
136714
|
148736
|
148737
|
148738
|
148739
|
148740
|
148741
|
148742
|
148743
|
148744
|
148745
|
150989
|
150990
|
150991
|
150992
|
150993
|
150994
|
150995
|
150996
|
150997
|
150998
|
156939
|
156940
|
156941
|
156942
|
156943
|
156944
|
156945
|
156946
|
156947
|
156948
|
156949
|
156965
|
157049
|
157071
|
157072
|
157073
|
157074
|
157075
|
157076
|
157077
|
157078
|
157079
|
157080
|
157081
|
157406
|
157407
|
157408
|
157409
|
157410
|
157411
|
157412
|
157413
|
157414
|
157415
|
157416
|
157673
|
157679
|
157683
|
157799
|
157881
|
157882
|
157883
|
157884
|
157885
|
157886
|
157887
|
157888
|
157889
|
157890
|
157891
|
157892
| 157893 |
158013