[Koha-bugs] [Bug 16699] Swagger: Split parameters and paths, and specify required permissions for resource

[bugzilla-daemon at bugs.koha-community.org]

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=16699

Benjamin Rokseth <benjamin.rokseth at kul.oslo.kommune.no> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |benjamin.rokseth at kul.oslo.k
                   |                            |ommune.no

--- Comment #1 from Benjamin Rokseth <benjamin.rokseth at kul.oslo.kommune.no> ---
(In reply to Lari Taskula from comment #0)
> It's great that Bug 15126 splits Swagger specification over multiple files.
> However, the problem of still exists as swagger.json grows larger with each
> new path. We should do the same split as Bug 15126 did, but for paths and
> parameters. I propose the following structure for paths:
> 
> .
> ├── swagger.json
> ├── definitions
> │   └── index.json
> │   └── error.json
> │   └── patron.json
> ├── parameters
> │   └── index.json
> │   └── patron.json
> └── paths
>     ├── index.json
>     └── patrons.json
> 
> Also Swagger should specify the required permissions for each resource. We
> can do this by adding "x-koha-permission"-field for each path, and using
> this field when checking for the needed permissions. This way required
> permissions are well-documented and anyone can instantly find out which
> permissions they need.

Agree with this one, patching swagger.json for each api update/enhancement is
cumbersome and prone for errors. As it seems you have already implemented this,
please submit patch and I will review asap.

-- 
You are receiving this mail because:
You are the assignee for the bug.
You are watching all bug changes.