https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |tomascohen@gmail.com |ity.org | Status|NEW |ASSIGNED CC| |jonathan.druart@bugs.koha-c | |ommunity.org, | |katrin.fischer@bsz-bw.de, | |kyle@bywatersolutions.com, | |martin.renvoize@ptfs-europe | |.com Depends on| |28157 --- Comment #1 from Tomás Cohen Arazi <tomascohen@gmail.com> --- I decided to make this dependent on bug 28157, which would really benefit from adding some documentation like this. So it is a good first addition. Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28157 [Bug 28157] Add the ability to set a library from which an API request pretends to come from -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 --- Comment #2 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Created attachment 119963 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=119963&action=edit Bug 28189: Move swagger file to YAML format This patch changes the base OpenAPI file (swagger.json) into YAML. The motivation for this, is adding more documentation, in Markdown. JSON doesn't accept multiline strings, so this seems like a good move for readability. To test: 1. Verify your API is functional 2. Apply this patch 3. Repeat 1 => SUCCESS: No changes, really 4. Point your browser to /api/v1/.html => SUCCESS: Some nicely formatted description of the API can be seen. It includes information about x-koha-library. 5. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 David Cook <dcook@prosentient.com.au> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |dcook@prosentient.com.au --- Comment #3 from David Cook <dcook@prosentient.com.au> --- No argument here. YAML is way nicer to work with as a human. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #120004|0 |1 is obsolete| | --- Comment #6 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 120005 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=120005&action=edit Bug 28189: Move swagger file to YAML format This patch changes the base OpenAPI file (swagger.json) into YAML. The motivation for this, is adding more documentation, in Markdown. JSON doesn't accept multiline strings, so this seems like a good move for readability. To test: 1. Verify your API is functional 2. Apply this patch 3. Repeat 1 => SUCCESS: No changes, really 4. Point your browser to /api/v1/.html => SUCCESS: Some nicely formatted description of the API can be seen. It includes information about x-koha-library. 5. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 --- Comment #8 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- (In reply to Jonathan Druart from comment #7)

Koha/REST/V1.pm: $self->home->rel_file("api/v1/swagger/swagger.json"),

Not this one?

That's interesting.. I didn't look deep into the code when I tested.. I just tested that routes continued to work and that the docs route continued to work.. and in both cases they worked fine.. seems the plugin doesn't care about the file extension.. that's surprising.. I agree though.. it should be corrected here.. well spotted. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 --- Comment #10 from Tomás Cohen Arazi <tomascohen@gmail.com> --- (In reply to David Cook from comment #9)

I'm not sure I'm following the flow but I'm guessing Jonathan was referring to th swagger.json line in the fallback section?

Yes, it was a busy Friday. Will fix it tomorrow. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Tomás Cohen Arazi <tomascohen@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Failed QA |Passed QA --- Comment #12 from Tomás Cohen Arazi <tomascohen@gmail.com> --- Sorry for the delay. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 --- Comment #13 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- Pushed to master for 21.05, thanks to everybody involved! -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Jonathan Druart <jonathan.druart+koha@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |additional_work_needed --- Comment #14 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- t/db_dependent/Koha/REST/Plugin/PluginRoutes.t is failing, please fix ASAP. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 --- Comment #16 from Jonathan Druart <jonathan.druart+koha@gmail.com> --- Created attachment 121053 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=121053&action=edit Bug 28189: Fix PluginRoutes.t So, this one was hidden. The failures were: # Failed test 'Bad plugins raise warning' # at t/db_dependent/Koha/REST/Plugin/PluginRoutes.t line 75. # found warning: Warning: Could not load REST API spec bundle: Invalid JSON specification HASH(0x556972b22da0): # found warning: Warning: Could not load REST API spec bundle: Invalid JSON specification HASH(0x5569735b8368): # expected to find warning: (?^u:Could not load REST API spec bundle: Invalid JSON specification) # expected to find warning: (?^u:The resulting spec is invalid. Skipping Bad API Route Plugin) And the correct error was (after a debug warn in JSON::Validator): Warning: Could not load REST API spec bundle: Invalid JSON specification HASH(0x55fd0c3d3160): - /info/version: Expected string - got number. at /usr/share/perl5/JSON/Validator.pm line 165. So this patch fixes it, but I don't understand why it's only failing for plugin routes however. -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Fridolin Somers <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |fridolin.somers@biblibre.co | |m --- Comment #18 from Fridolin Somers <fridolin.somers@biblibre.com> --- Enhancement not pushed to 20.11.x -- You are receiving this mail because: You are watching all bug changes.

https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28189 Fridolin Somers <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Blocks| |17314 Referenced Bugs: https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17314 [Bug 17314] Routes to create, list and delete a purchase suggestion -- You are receiving this mail because: You are watching all bug changes.