openapi: 3.2.0
info:
  title: Ansible AI Connect. Telemetry API
  version: 1.0.0 (v1)
  description: Equip the automation developer at Lightspeed.
servers:
- url: https://lightspeed-instance/api/v1
  description: Direct access to a Lightspeed instance
- url: https://aap/api/lightspeed/v1
  description: Access through an Ansible Automation Platfrom gateway
tags:
- name: Telemetry
paths:
  /telemetry/:
    get:
      operationId: telemetry_settings_get
      summary: Get the telemetry settings for an Organisation
      tags:
      - Telemetry
      security:
      - oauth2:
        - read
        - write
      - cookieAuth: []
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Request was throttled
        '500':
          description: Internal service error
        '501':
          description: Not implemented
      x-ai-description: Get telemetry settings
    post:
      operationId: telemetry_settings_set
      summary: Set the Telemetry settings for an Organisation
      tags:
      - Telemetry
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TelemetrySettingsRequest'
            examples:
              ValidExample:
                value:
                  optOut: true
                summary: Request Telemetry settings
                description: A valid request to set the Telemetry settings.
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/TelemetrySettingsRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TelemetrySettingsRequest'
        required: true
      security:
      - oauth2:
        - read
        - write
      - cookieAuth: []
      responses:
        '204':
          description: Empty response
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Request was throttled
        '500':
          description: Internal service error
        '501':
          description: Not implemented
      x-ai-description: Set telemetry settings
components:
  schemas:
    TelemetrySettingsRequest:
      type: object
      properties:
        optOut:
          type: boolean
          description: Indicates whether the Red Hat Organization opts out of telemetry collection.
      required:
      - optOut
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /o/authorize/
          tokenUrl: /o/token/
          scopes:
            read: Read basic user information
            write: Request Ansible content suggestions
            delete: Delete resources