variables.yaml

openapi: 3.0.0
info:
  title: Variables API
  version: 1.0.0
  license:
    name: MIT
    url: https://github.com/aziontech/azionapi-openapi/blob/main/LICENSE.md
servers:
- description: Production
  url: https://api.azionapi.net
security:
- tokenAuth: []
paths:
  /variables:
    get:
      summary: /variables
      operationId: api_variables_list
      description: List all user's Variables.
      tags:
      - Variables
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Variable'
          description: ''
        '404':
          description: Not Found
    post:
      operationId: api_variables_create
      summary: /variables
      description: Create a new Variable. <br><ul><li>If the attribute "secret" is
        informed with value "true" in request payload the Variable value will be secret
        and no longer viewable after creation.</li><li>If the attribute "secret" is
        not informed the Variable value will be considered as not secret by default.</li></ul>
      tags:
      - Variables
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableCreate'
            examples:
              SimpleVariableCreation:
                value:
                  key: MY_SIMPLE_VAR
                  value: My not secret value
                summary: Simple Variable creation
              SecretVariableCreation:
                value:
                  key: MY_SECRET_VAR
                  value: My secret value
                  secret: true
                summary: Secret Variable creation
        required: true
      security:
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableGet'
          description: ''
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
  /variables/{uuid}:
    get:
      operationId: api_variables_retrieve
      summary: /variables/:uuid
      description: Retrieve all data for a Variable by it's UUID
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
        required: true
      tags:
      - Variables
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Variable'
          description: ''
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    put:
      operationId: api_variables_update
      summary: /variables/:uuid
      description: Update variable attributes by it's UUID. Keep the Variable UUID
        but overwrite all editable attributes.
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
        required: true
      tags:
      - Variables
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableCreate'
            examples:
              SimpleVariableUpdate:
                value:
                  key: MY_NEW_SIMPLE_VAR_KEY
                  value: My new not secret value
                summary: Simple Variable update
              SecretVariableUpdate:
                value:
                  key: MY_NEW_SECRET_VAR_KEY
                  value: My new secret value
                  secret: true
                summary: Secret Variable update
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/VariableCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VariableCreate'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableGet'
          description: ''
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
    delete:
      operationId: api_variables_destroy
      summary: /variables/:uuid
      description: Delete a Variable by it's UUID
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
        required: true
      tags:
      - Variables
      security:
      - tokenAuth: []
      responses:
        '204':
          description: No response body
        '400':
          description: Bad Request
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '500':
          description: Internal Server Error
components:
  schemas:
    Variable:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        key:
          type: string
          minLength: 1
          maxLength: 100
        value:
          type: string
          minLength: 1
          maxLength: 32768
        secret:
          type: boolean
          readOnly: true
        last_editor:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - created_at
      - key
      - last_editor
      - secret
      - updated_at
      - uuid
      - value
    VariableCreate:
      type: object
      properties:
        key:
          type: string
          minLength: 1
          maxLength: 100
        value:
          type: string
          minLength: 1
          maxLength: 32768
        secret:
          type: boolean
      required:
      - key
      - value
    VariableGet:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        key:
          type: string
          minLength: 1
          maxLength: 100
        value:
          type: string
          minLength: 1
          maxLength: 32768
          description: |-
            Given the *incoming* primitive data, return the value for this field
            that should be validated and transformed to a native value.
          readOnly: true
        secret:
          type: boolean
          readOnly: true
        last_editor:
          type: string
          readOnly: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
      required:
      - created_at
      - key
      - last_editor
      - secret
      - updated_at
      - uuid
      - value
  securitySchemes:
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"