Tomas Cohen Arazi
b7b6a85de5
This patch intends to be a guide for inserting Markdown documentation
for error codes. The idea is that it can be copied and pasted as-is in
new routes. And adapted to new error codes.
To test:
1. Apply this patch
2. Run:
$ npx redoc-cli@0.10.4 bundle --cdn --output index.html \
api/v1/swagger/swagger.yaml
=> SUCCESS: It builds correctly
3. Open index.tml on your browser
4. Pick a route, and see the 500 status description includes information
about the possible `error_code` values.
5. Sign off :-D
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Andrew Fuerste-Henry <andrew@bywatersolutions.com>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
382 lines
10 KiB
YAML
382 lines
10 KiB
YAML
---
|
|
/advanced_editor/macros:
|
|
get:
|
|
x-mojo-to: AdvancedEditorMacro#list
|
|
operationId: listMacro
|
|
tags:
|
|
- macros
|
|
summary: List advanced editor macros
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- name: name
|
|
in: query
|
|
description: Case insensative search on macro name
|
|
required: false
|
|
type: string
|
|
- name: macro_text
|
|
in: query
|
|
description: Case insensative search on macro text
|
|
required: false
|
|
type: string
|
|
- name: patron_id
|
|
in: query
|
|
description: Search on internal patron_id
|
|
required: false
|
|
type: string
|
|
- name: shared
|
|
in: query
|
|
description: Search on shared macros
|
|
required: false
|
|
type: string
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
responses:
|
|
"200":
|
|
description: A list of macros
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: |
|
|
Internal server error. Possible `error_code` attribute values:
|
|
|
|
* `internal_server_error`
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue: advanced_editor
|
|
post:
|
|
x-mojo-to: AdvancedEditorMacro#add
|
|
operationId: addAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Add advanced editor macros
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new macro
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Macro added
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue: advanced_editor
|
|
/advanced_editor/macros/shared:
|
|
post:
|
|
x-mojo-to: AdvancedEditorMacro#add_shared
|
|
operationId: addsharedAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Add shared advanced editor macros
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new macro
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Macro added
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue:
|
|
advanced_editor: 1
|
|
create_shared_macros: 1
|
|
"/advanced_editor/macros/{advancededitormacro_id}":
|
|
get:
|
|
x-mojo-to: AdvancedEditorMacro#get
|
|
operationId: getAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Get advanced editor macro
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/advancededitormacro_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A macro
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: AdvancedEditorMacro not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue: advanced_editor
|
|
put:
|
|
x-mojo-to: AdvancedEditorMacro#update
|
|
operationId: updateAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Update advanced editor macro
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/advancededitormacro_id_pp
|
|
- name: body
|
|
in: body
|
|
description: An advanced editor macro object
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: An advanced editor macro
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Macro not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue: advanced_editor
|
|
delete:
|
|
x-mojo-to: AdvancedEditorMacro#delete
|
|
operationId: deleteAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Delete advanced editor macro
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/advancededitormacro_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: Advanced editor macro deleted
|
|
schema:
|
|
type: string
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Macro not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue: advanced_editor
|
|
"/advanced_editor/macros/shared/{advancededitormacro_id}":
|
|
get:
|
|
x-mojo-to: AdvancedEditorMacro#get_shared
|
|
operationId: getsharedAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Get shared advanced editor macro
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/advancededitormacro_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A macro
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: AdvancedEditorMacro not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue: advanced_editor
|
|
put:
|
|
x-mojo-to: AdvancedEditorMacro#update_shared
|
|
operationId: updatesharedAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Update shared advanced editor macro
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/advancededitormacro_id_pp
|
|
- name: body
|
|
in: body
|
|
description: An advanced editor macro object
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: An advanced editor macro
|
|
schema:
|
|
$ref: ../definitions.yaml#/advancededitormacro
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Macro not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue:
|
|
advanced_editor: 1
|
|
create_shared_macros: 1
|
|
delete:
|
|
x-mojo-to: AdvancedEditorMacro#delete_shared
|
|
operationId: deletesharedAdvancedEditorMacro
|
|
tags:
|
|
- macros
|
|
summary: Delete shared advanced editor macro
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/advancededitormacro_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: Advanced editor macro deleted
|
|
schema:
|
|
type: string
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Macro not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
editcatalogue:
|
|
advanced_editor: 1
|
|
delete_shared_macros: 1
|