openapi: 3.0.3

info:
  title: rnd.is
  version: 0.2.0
  description: An API to generate random values.
  license:
    name: MIT License
    url: https://opensource.org/licenses/MIT
  x-logo:
    url: https://i.postimg.cc/5t7GCYH1/rnd-is-logo-rclear.png

servers:
  - url: rnd.is
    description: 'Publicly available service'

externalDocs:
  url: https://github.com/mamichels/rnd.is

paths:
  /:
    get:
      summary: root
      responses:
        200:
            description: 'I respond, enjoy crawling. ψ(._. )>'
            content:
                text/plain:
                  schema:
                      type: string
                      example: 'rnd.is'
  /number:
    get:
      summary: Resolves a single random number
      parameters:
        - name: min
          description: The lower bound of the expected random number.
          example: '1'
          schema:
            format: number
            pattern: ^\d+$
            type: number
          in: query
          required: true
        - name: max
          description: The upper bound of the expected random number.
          example: '10'
          schema:
            format: number
            pattern: ^\d+$
            type: number
          in: query
          required: true
      responses:
        '200':
          description: A random number between min and max.
          content:
            application/json:
              schema:
                required:
                  - apiVersion
                  - data
                type: object
                properties:
                  apiVersion:
                    type: string
                    example: '0.1.0'
                  params:
                    type: object
                    example:
                      min: 1
                      max: 10
                  data:
                    type: object
                    properties:
                      kind:
                        type: string
                        example: 'number'
                      value:
                        type: number
                        example: '5'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
  /numbers:
    get:
      summary: Resolves a set of random numbers
      parameters:
        - name: min
          description: The lower bound of the expected random number.
          example: '1'
          schema:
            format: number
            pattern: ^\d+$
            type: number
          in: query
          required: true
        - name: max
          description: The upper bound of the expected random number.
          example: '10'
          schema:
            format: number
            pattern: ^\d+$
            type: number
          in: query
          required: true
        - name: length
          description: The number of random numbers to resolve.
          example: '3'
          schema:
            format: number
            pattern: ^\d+$
            type: number
          in: query
          required: true
      responses:
        '200':
          description: A array of random numbers between min and max.
          content:
            application/json:
              schema:
                required:
                  - apiVersion
                  - data
                type: object
                properties:
                  apiVersion:
                    type: string
                    example: '0.1.0'
                  params:
                    type: object
                    example:
                      min: 1
                      max: 10
                  data:
                    type: object
                    properties:
                      kind:
                        type: string
                        example: 'number'
                      value:
                        type: array
                        example: '[10, 2, 3]'
                        items:
                          type: number
                          example: '5'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object
  /uuid:
    get:
      summary: Resolves an uuid
      responses:
        '200':
          description: A response containing a uuid.
          content:
            application/json:
              schema:
                required:
                  - apiVersion
                  - data
                type: object
                properties:
                  apiVersion:
                    type: string
                    example: '0.1.0'
                  params:
                    type: object
                    example:
                      min: 1
                      max: 10
                  data:
                    type: object
                    properties:
                      kind:
                        type: string
                        example: 'string'
                      value:
                        type: string
                        example: '4876d3bd-b433-4b99-a159-4e8ccc9362d9'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                type: object