Summary: | Standardize our swagger yaml spec files | ||
---|---|---|---|
Product: | Koha | Reporter: | Jonathan Druart <jonathan.druart> |
Component: | Architecture, internals, and plumbing | Assignee: | Bugs List <koha-bugs> |
Status: | Patch doesn't apply --- | QA Contact: | Testopia <testopia> |
Severity: | enhancement | ||
Priority: | P5 - low | CC: | martin.renvoize, tomascohen |
Version: | unspecified | ||
Hardware: | All | ||
OS: | All | ||
Change sponsored?: | --- | Patch complexity: | --- |
Documentation contact: | Documentation submission: | ||
Text to go in the release notes: | Version(s) released in: | ||
Circulation function: | |||
Bug Depends on: | 30536 | ||
Bug Blocks: | |||
Attachments: |
Bug 30385: Standardize our swagger yaml spec files
Script to generate |
Description
Jonathan Druart
2022-03-28 14:48:07 UTC
Created attachment 133110 [details] [review] Bug 30385: Standardize our swagger yaml spec files Created attachment 133111 [details] [review] Script to generate Tomas, Martin, do we want that? If so it's now, it will be a nightmare to rebase. I like consistency.. looks good to me :) Now conflicting with bug 30536. No idea was the deps have been reversed. Abandoning it as it's a mess to rebase and wasn't supposed to wait that much in the queue. Now conflicting with bug 30536. No idea why the deps have been reversed. I am abandoning it as it's a mess to rebase and it wasn't supposed to wait that much in the queue. I'm less sure about this now.. having delved through it I don't like how we re-order the keys within the parameters block.. We were pretty consistently as below: parameters: - name: x-koha-embed in: header description: Embed list sent as request header required: false type: array items: enum: - extended_attributes type: string collectionFormat: csv This now comes out as: parameters: - collectionFormat: csv description: Embed list send as request header in: header items: enum: - extened_attributes type: string name: x-koha-embed required: false type: array I find the second much harder to read at a glance. That's why I reversed the dependencies.. because I felt there was still work to be done here. I am failing at writing a script that will order the second (and more) level or keys. Help welcomed! :) Might be a Friday effect. |