openapi.yaml

# This file is auto-generated by rspec-openapi https://github.com/k0kubun/rspec-openapi
#
# When you write a spec in spec/requests, running the spec with `OPENAPI=1 rspec` will
# update this file automatically. You can also manually edit this file.
---
openapi: 3.1.0
info:
  title: rspec-openapi
  version: 1.0.0
  description: My beautiful API
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: http://localhost:3000
paths:
  "/tables/{id}":
    delete:
      summary: destroy
      tags:
      - Table
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: returns a table
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  description:
                    type: string
                  database:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                  null_sample:
                    nullable: true
                  storage_size:
                    type: number
                    format: float
                  created_at:
                    type: string
                  updated_at:
                    type: string
              examples:
                returns a table:
                  id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
        '202':
          description: returns no content if specified
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                no_content:
                  type: string
            example:
              no_content: 'true'
            examples:
              returns no content if specified:
                no_content: 'true'
    get:
      summary: show
      tags:
      - Table
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        example: 2
      responses:
        '200':
          description: returns a table
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  description:
                    type: string
                  database:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                  null_sample:
                    nullable: true
                  storage_size:
                    type: number
                    format: float
                  created_at:
                    type: string
                  updated_at:
                    type: string
              examples:
                returns a table:
                  id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
        '401':
          description: does not return a table if unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              examples:
                does not return a table if unauthorized:
                  message: Unauthorized
        '404':
          description: does not return a table if not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              examples:
                does not return a table if not found:
                  message: not found
    patch:
      summary: update
      tags:
      - Table
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        example: 1
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                nested:
                  type: object
                  properties:
                    image:
                      type: string
                      format: binary
                    caption:
                      type: string
            examples:
              returns a table:
                nested:
                  image: test.png
                  caption: Some caption
      responses:
        '200':
          description: returns a table
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  description:
                    type: string
                  database:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                  null_sample:
                    nullable: true
                  storage_size:
                    type: number
                    format: float
                  created_at:
                    type: string
                  updated_at:
                    type: string
              examples:
                returns a table:
                  id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
  "/tables":
    get:
      summary: index
      tags:
      - Table
      parameters:
      - name: X-Authorization-Token
        in: header
        required: true
        schema:
          type: string
        example: token
      - name: filter[name]
        in: query
        schema:
          type: object
          properties:
            name:
              type: string
        example:
          name: Example Table
      - name: filter[price]
        in: query
        schema:
          type: object
          properties:
            price:
              type: string
        example:
          price: '0'
      - name: page
        in: query
        schema:
          type: integer
        example: 1
      - name: per
        in: query
        schema:
          type: integer
        example: 10
      responses:
        '200':
          description: with different deep query parameters
          headers:
            X-Cursor:
              schema:
                type: integer
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    name:
                      type: string
                    description:
                      type: string
                    database:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                    null_sample:
                      nullable: true
                    storage_size:
                      type: number
                      format: float
                    created_at:
                      type: string
                    updated_at:
                      type: string
              examples:
                with flat query parameters:
                - id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
                with deep query parameters:
                - id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
                with different deep query parameters:
                - id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
        '401':
          description: does not return tables if unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              examples:
                does not return tables if unauthorized:
                  message: Unauthorized
    post:
      summary: create
      tags:
      - Table
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                database_id:
                  type: integer
            examples:
              returns a table:
                name: k0kubun
                description: description
                database_id: 2
      responses:
        '201':
          description: returns a table
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  description:
                    type: string
                  database:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                  null_sample:
                    nullable: true
                  storage_size:
                    type: number
                    format: float
                  created_at:
                    type: string
                  updated_at:
                    type: string
              examples:
                returns a table:
                  id: 1
                  name: access
                  description: logs
                  database:
                    id: 2
                    name: production
                  null_sample:
                  storage_size: 12.3
                  created_at: '2020-07-17T00:00:00+00:00'
                  updated_at: '2020-07-17T00:00:00+00:00'
  "/test_block":
    get:
      summary: GET /test_block
      tags: []
      responses:
        '200':
          description: returns the block content
          content:
            text/plain:
              schema:
                type: string
              examples:
                returns the block content: A TEST
  "/images":
    get:
      summary: index
      tags:
      - Image
      responses:
        '200':
          description: can return an object with an attribute of empty array
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                    tags:
                      type: array
                      items: {}
              examples:
                can return an object with an attribute of empty array:
                - name: file.png
                  tags: []
  "/images/{id}":
    get:
      summary: show
      tags:
      - Image
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: returns a image payload
          content:
            image/png:
              schema:
                type: string
                format: binary
              examples:
                returns a image payload:
  "/eng_route":
    get:
      summary: GET /eng_route
      tags: []
      responses:
        '200':
          description: returns some content from the engine
          content:
            text/plain:
              schema:
                type: string
              examples:
                returns some content from the engine: AN ENGINE TEST