Aloft Auto Tags API

Auto Tags

OpenAPI Specification

aloft-auto-tags-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  title: Aloft API V1 Accounts Auto Tags API
  contact:
    email: support@aloft.ai
  version: 1.0.0
  description: Accounts
tags:
- name: Auto Tags
  description: Auto Tags
paths:
  /v1/account/{account_id}/auto-tags:
    get:
      tags:
      - Auto Tags
      summary: Gets auto tags
      description: Gets auto tags
      operationId: 10940bb3a68651336692ca350c00f4b4
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: order_by
        in: query
        description: The field to order the data by
        schema:
          type: string
          enum:
          - source
          - target
          - created_at
      - name: order
        in: query
        schema:
          $ref: '#components/schemas/order_direction'
      - name: source[]
        in: query
        description: array of source types
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - flights
            - aircrafts
            - missions
            - users
      - name: target[]
        in: query
        description: array of target types
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - flights
            - aircrafts
            - missions
            - users
      - name: trigger_condition[]
        in: query
        description: array of target types
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - mission_participant
            - flight_pilot
            - flight_aircraft
            - flight_mission
      - name: appends[]
        in: query
        description: array of model names
        schema:
          type: array
          items:
            description: A list of models to attach
            type: string
            enum:
            - tag_group
            - tag_group.tags
      - name: page
        in: query
        schema:
          type: integer
      - name: page_length
        in: query
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
          content:
            application/json: {}
            application/csv: {}
      security:
      - Aloft Token: []
    post:
      tags:
      - Auto Tags
      summary: Create an Auto Tag
      description: Create an Auto Tag
      operationId: 5f3d5d66040d65d7f7ab5a8467e011a1
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: appends[]
        in: query
        description: array of model names
        schema:
          type: array
          items:
            type: string
            enum:
            - tag_group
            - tag_group.tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/auto_tag'
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Content
        '200':
          description: Successful operation
      security:
      - Aloft Token: []
  /v1/account/{account_id}/auto-tags/{auto_tag_id}:
    get:
      tags:
      - Auto Tags
      summary: Get an auto tag
      description: Get an auto tag
      operationId: 6005f6d8ec756f6e11edad041ab339f5
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: auto_tag_id
        in: path
        required: true
        schema:
          type: integer
      - name: appends[]
        in: query
        description: array of model names
        schema:
          type: array
          items:
            type: string
            enum:
            - tag_group
            - tag_group.tags
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '200':
          description: Successful operation
          content:
            application/json: {}
      security:
      - Aloft Token: []
    put:
      tags:
      - Auto Tags
      summary: Update an Auto Tag
      description: Update an Auto Tag
      operationId: 53bff2221c7a068daf9417b3170c88d8
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: auto_tag_id
        in: path
        required: true
        schema:
          type: integer
      - name: appends[]
        in: query
        description: array of model names
        schema:
          type: array
          items:
            type: string
            enum:
            - tag_group
            - tag_group.tags
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#components/schemas/auto_tag'
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '422':
          description: Unprocessable Content
        '200':
          description: Successful operation
      security:
      - Aloft Token: []
    delete:
      tags:
      - Auto Tags
      summary: Delete an Auto Tag
      description: Delete an Auto Tag
      operationId: 2ea05946f16ff0b1602ec0ef6e28e659
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#components/schemas/model_id'
      - name: auto_tag_id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '403':
          description: Access Denied
        '401':
          description: Unauthorized
        '204':
          description: Successful operation
      security:
      - Aloft Token: []
components:
  securitySchemes:
    Aloft Token:
      type: http
      name: Aloft Token
      in: header
      scheme: bearer