NoBueno cities API

The cities API from NoBueno — 4 operation(s) for cities.

OpenAPI Specification

nobueno-cities-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Jungle admin cities API
  description: Here magic happens
  termsOfService: https://www.google.com/policies/terms/
  contact:
    email: mindru.ion97@gmail.com
  license:
    name: BSD License
  version: v1
host: api.nobueno.com
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- Bearer: []
- Device-type: []
- REFETCH_SCHEMA_WITH_AUTH: []
- x-app-id: []
- x-scheme: []
tags:
- name: cities
paths:
  /cities:
    parameters: []
    get:
      operationId: cities_list
      description: ''
      parameters:
      - name: search
        in: query
        description: A search term.
        required: false
        type: string
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        type: integer
      - name: perPage
        in: query
        description: Number of results to return per page.
        required: false
        type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
            - count
            - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/City'
      tags:
      - cities
  /cities/autocomplete:
    parameters: []
    get:
      operationId: cities_autocomplete
      description: ''
      parameters:
      - name: search
        in: query
        description: A search term.
        required: false
        type: string
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        type: integer
      - name: perPage
        in: query
        description: Number of results to return per page.
        required: false
        type: integer
      responses:
        '200':
          description: Autocomplete
          schema:
            $ref: '#/definitions/Autocomplete'
      tags:
      - cities
  /cities/list:
    parameters: []
    get:
      operationId: cities_list_dropdown
      description: ''
      parameters:
      - name: search
        in: query
        description: A search term.
        required: false
        type: string
      - name: page
        in: query
        description: A page number within the paginated result set.
        required: false
        type: integer
      - name: perPage
        in: query
        description: Number of results to return per page.
        required: false
        type: integer
      responses:
        '200':
          description: ''
          schema:
            required:
            - count
            - results
            type: object
            properties:
              count:
                type: integer
              next:
                type: string
                format: uri
                x-nullable: true
              previous:
                type: string
                format: uri
                x-nullable: true
              results:
                type: array
                items:
                  $ref: '#/definitions/CityList'
      tags:
      - cities
  /cities/{id}:
    parameters:
    - name: id
      in: path
      description: A unique integer value identifying this city.
      required: true
      type: integer
    get:
      operationId: cities_read
      description: ''
      parameters: []
      responses:
        '200':
          description: ''
          schema:
            $ref: '#/definitions/City'
      tags:
      - cities
definitions:
  City:
    required:
    - title
    type: object
    properties:
      id:
        title: ID
        type: integer
        readOnly: true
      title:
        title: Title
        type: string
        maxLength: 200
        minLength: 1
  CityList:
    required:
    - value
    - label
    type: object
    properties:
      value:
        title: Value
        type: integer
      label:
        title: Label
        type: string
        minLength: 1
      code:
        title: Code
        type: string
        readOnly: true
  Autocomplete:
    required:
    - items
    type: object
    properties:
      items:
        type: array
        items:
          type: string
          minLength: 1
securityDefinitions:
  Bearer:
    type: apiKey
    name: Authorization
    in: header
  Device-type:
    type: apiKey
    name: Device-Type
    in: header
  x-scheme:
    type: apiKey
    name: x-scheme
    in: header
  x-app-id:
    type: apiKey
    name: x-app-id
    in: header
  REFETCH_SCHEMA_WITH_AUTH: true