[Koha-bugs] [Bug 16699] New: 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

            Bug ID: 16699
           Summary: Swagger: Split parameters and paths, and specify
                    required permissions for resource
 Change sponsored?: ---
           Product: Koha
           Version: master
          Hardware: All
                OS: All
            Status: NEW
          Severity: enhancement
          Priority: P5 - low
         Component: Web services
          Assignee: koha-bugs at lists.koha-community.org
          Reporter: larit at student.uef.fi
        QA Contact: testopia at bugs.koha-community.org

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.

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