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>
219 lines
5.5 KiB
YAML
219 lines
5.5 KiB
YAML
---
|
|
/cities:
|
|
get:
|
|
x-mojo-to: Cities#list
|
|
operationId: listCities
|
|
tags:
|
|
- cities
|
|
summary: List cities
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- name: name
|
|
in: query
|
|
description: Case insensative search on city name
|
|
required: false
|
|
type: string
|
|
- name: state
|
|
in: query
|
|
description: Case insensative search on city state
|
|
required: false
|
|
type: string
|
|
- name: country
|
|
in: query
|
|
description: Case insensative search on city country
|
|
required: false
|
|
type: string
|
|
- name: postal_code
|
|
in: query
|
|
description: Case Insensative search on city postal code
|
|
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 cities
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/city
|
|
"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:
|
|
catalogue: "1"
|
|
post:
|
|
x-mojo-to: Cities#add
|
|
operationId: addCity
|
|
tags:
|
|
- cities
|
|
summary: Add city
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new hold
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/city
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: City added
|
|
schema:
|
|
$ref: ../definitions.yaml#/city
|
|
"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:
|
|
parameters: manage_cities
|
|
"/cities/{city_id}":
|
|
get:
|
|
x-mojo-to: Cities#get
|
|
operationId: getCity
|
|
tags:
|
|
- cities
|
|
summary: Get city
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/city_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A city
|
|
schema:
|
|
$ref: ../definitions.yaml#/city
|
|
"404":
|
|
description: City 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:
|
|
catalogue: "1"
|
|
put:
|
|
x-mojo-to: Cities#update
|
|
operationId: updateCity
|
|
tags:
|
|
- cities
|
|
summary: Update city
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/city_id_pp
|
|
- name: body
|
|
in: body
|
|
description: A city object
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/city
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A city
|
|
schema:
|
|
$ref: ../definitions.yaml#/city
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: City 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:
|
|
parameters: manage_cities
|
|
delete:
|
|
x-mojo-to: Cities#delete
|
|
operationId: deleteCity
|
|
tags:
|
|
- cities
|
|
summary: Delete city
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/city_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: City deleted
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: City 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:
|
|
parameters: manage_cities
|