Scott Ai walkthroughs API

The walkthroughs API from Scott Ai — 3 operation(s) for walkthroughs.

OpenAPI Specification

scott-ai-walkthroughs-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: One-Shot access walkthroughs API
  version: 1.0.0
tags:
- name: walkthroughs
paths:
  /walkthroughs/pending:
    get:
      tags:
      - walkthroughs
      summary: Get Pending Walkthrough
      description: Return the next pending walkthrough name for the current user, or null.
      operationId: get_pending_walkthrough
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PendingWalkthroughResponse'
      security:
      - HTTPBearer: []
  /walkthroughs/{name}/complete:
    post:
      tags:
      - walkthroughs
      summary: Complete Walkthrough
      operationId: complete_walkthrough
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalkthroughActionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /walkthroughs/{name}/dismiss:
    post:
      tags:
      - walkthroughs
      summary: Dismiss Walkthrough
      operationId: dismiss_walkthrough
      security:
      - HTTPBearer: []
      parameters:
      - name: name
        in: path
        required: true
        schema:
          type: string
          title: Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalkthroughActionResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    PendingWalkthroughResponse:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
      type: object
      required:
      - name
      title: PendingWalkthroughResponse
    WalkthroughActionResponse:
      properties:
        name:
          type: string
          title: Name
        status:
          type: string
          enum:
          - completed
          - dismissed
          title: Status
      type: object
      required:
      - name
      - status
      title: WalkthroughActionResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer