Koha-clms/api/v1/swagger/paths/cities.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: "../swagger.yaml#/parameters/match"
      - $ref: "../swagger.yaml#/parameters/order_by"
      - $ref: "../swagger.yaml#/parameters/page"
      - $ref: "../swagger.yaml#/parameters/per_page"
      - $ref: "../swagger.yaml#/parameters/q_param"
      - $ref: "../swagger.yaml#/parameters/q_body"
      - $ref: "../swagger.yaml#/parameters/request_id_header"
    responses:
      "200":
        description: A list of cities
        schema:
          type: array
          items:
            $ref: "../swagger.yaml#/definitions/city"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/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: "../swagger.yaml#/definitions/city"
    produces:
      - application/json
    responses:
      "201":
        description: City added
        schema:
          $ref: "../swagger.yaml#/definitions/city"
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/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: "../swagger.yaml#/parameters/city_id_pp"
    produces:
      - application/json
    responses:
      "200":
        description: A city
        schema:
          $ref: "../swagger.yaml#/definitions/city"
      "404":
        description: City not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: |
          Internal server error. Possible `error_code` attribute values:

          * `internal_server_error`          
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        catalogue: "1"
  put:
    x-mojo-to: Cities#update
    operationId: updateCity
    tags:
      - cities
    summary: Update city
    parameters:
      - $ref: "../swagger.yaml#/parameters/city_id_pp"
      - name: body
        in: body
        description: A city object
        required: true
        schema:
          $ref: "../swagger.yaml#/definitions/city"
    produces:
      - application/json
    responses:
      "200":
        description: A city
        schema:
          $ref: "../swagger.yaml#/definitions/city"
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: City not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: Internal error
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        parameters: manage_cities
  delete:
    x-mojo-to: Cities#delete
    operationId: deleteCity
    tags:
      - cities
    summary: Delete city
    parameters:
      - $ref: "../swagger.yaml#/parameters/city_id_pp"
    produces:
      - application/json
    responses:
      "204":
        description: City deleted
      "401":
        description: Authentication required
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "403":
        description: Access forbidden
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "404":
        description: City not found
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "500":
        description: Internal error
        schema:
          $ref: "../swagger.yaml#/definitions/error"
      "503":
        description: Under maintenance
        schema:
          $ref: "../swagger.yaml#/definitions/error"
    x-koha-authorization:
      permissions:
        parameters: manage_cities