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>
307 lines
8.7 KiB
YAML
307 lines
8.7 KiB
YAML
---
|
|
/import_batch_profiles:
|
|
get:
|
|
x-mojo-to: ImportBatchProfiles#list
|
|
operationId: listImportBatchProfiles
|
|
tags:
|
|
- batch_import_profiles
|
|
summary: List batch import profiles
|
|
parameters:
|
|
- name: name
|
|
in: query
|
|
description: Search on profile's name
|
|
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
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of import batch profiles
|
|
schema:
|
|
$ref: ../definitions.yaml#/import_batch_profiles
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"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:
|
|
tools: stage_marc_import
|
|
post:
|
|
x-mojo-to: ImportBatchProfiles#add
|
|
operationId: addImportBatchProfiles
|
|
tags:
|
|
- batch_import_profiles
|
|
summary: Add batch import profile
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing a import batch profile
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
description: name of this profile
|
|
type: string
|
|
matcher_id:
|
|
description: the id of the match rule used (matchpoints.matcher_id)
|
|
type:
|
|
- integer
|
|
- "null"
|
|
template_id:
|
|
description: the id of the marc modification template
|
|
type:
|
|
- integer
|
|
- "null"
|
|
overlay_action:
|
|
description: how to handle duplicate records
|
|
type:
|
|
- string
|
|
- "null"
|
|
nomatch_action:
|
|
description: how to handle records where no match is found
|
|
type:
|
|
- string
|
|
- "null"
|
|
item_action:
|
|
description: what to do with item records
|
|
type:
|
|
- string
|
|
- "null"
|
|
parse_items:
|
|
description: should items be parsed
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
record_type:
|
|
description: type of record in the batch
|
|
type:
|
|
- string
|
|
- "null"
|
|
encoding:
|
|
description: file encoding
|
|
type:
|
|
- string
|
|
- "null"
|
|
format:
|
|
description: marc format
|
|
type:
|
|
- string
|
|
- "null"
|
|
comments:
|
|
description: any comments added when the file was uploaded
|
|
type:
|
|
- string
|
|
- "null"
|
|
additionalProperties: false
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Created Profile
|
|
schema:
|
|
$ref: ../definitions.yaml#/import_batch_profile
|
|
"400":
|
|
description: Missing or wrong parameters
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Hold not allowed
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Borrower not found
|
|
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:
|
|
tools: stage_marc_import
|
|
"/import_batch_profiles/{import_batch_profile_id}":
|
|
put:
|
|
x-mojo-to: ImportBatchProfiles#edit
|
|
operationId: editImportBatchProfiles
|
|
tags:
|
|
- batch_import_profiles
|
|
summary: Update batch import profile
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/import_batch_profile_id_pp
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing a import batch profile
|
|
required: true
|
|
schema:
|
|
type: object
|
|
properties:
|
|
name:
|
|
description: name of this profile
|
|
type: string
|
|
matcher_id:
|
|
description: the id of the match rule used (matchpoints.matcher_id)
|
|
type:
|
|
- integer
|
|
- "null"
|
|
template_id:
|
|
description: the id of the marc modification template
|
|
type:
|
|
- integer
|
|
- "null"
|
|
overlay_action:
|
|
description: how to handle duplicate records
|
|
type:
|
|
- string
|
|
- "null"
|
|
nomatch_action:
|
|
description: how to handle records where no match is found
|
|
type:
|
|
- string
|
|
- "null"
|
|
item_action:
|
|
description: what to do with item records
|
|
type:
|
|
- string
|
|
- "null"
|
|
parse_items:
|
|
description: should items be parsed
|
|
type:
|
|
- boolean
|
|
- "null"
|
|
record_type:
|
|
description: type of record in the batch
|
|
type:
|
|
- string
|
|
- "null"
|
|
encoding:
|
|
description: file encoding
|
|
type:
|
|
- string
|
|
- "null"
|
|
format:
|
|
description: marc format
|
|
type:
|
|
- string
|
|
- "null"
|
|
comments:
|
|
description: any comments added when the file was uploaded
|
|
type:
|
|
- string
|
|
- "null"
|
|
additionalProperties: false
|
|
consumes:
|
|
- application/json
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: Updated profile
|
|
schema:
|
|
$ref: ../definitions.yaml#/import_batch_profile
|
|
"400":
|
|
description: Missing or wrong parameters
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Hold not allowed
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Borrower not found
|
|
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:
|
|
tools: stage_marc_import
|
|
delete:
|
|
x-mojo-to: ImportBatchProfiles#delete
|
|
operationId: deleteImportBatchProfiles
|
|
tags:
|
|
- batch_import_profiles
|
|
summary: Delete batch import profile
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/import_batch_profile_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: Profile deleted
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Hold not allowed
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Hold not found
|
|
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:
|
|
tools: stage_marc_import
|