RunWhen tutorials API

The tutorials API from RunWhen — 2 operation(s) for tutorials.

OpenAPI Specification

runwhen-tutorials-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: papi alert-query-proxy tutorials API
  description: RunWhen Platform API
  version: 2.0.0
tags:
- name: tutorials
paths:
  /api/v3/workspaces/{workspace_name}/tutorials:
    get:
      tags:
      - tutorials
      summary: List tutorials (deprecated)
      description: Tutorials feature is deprecated. Returns empty list for backwards compatibility.
      operationId: list_workspace_tutorials_api_v3_workspaces__workspace_name__tutorials_get
      parameters:
      - name: workspace_name
        in: path
        required: true
        schema:
          type: string
          title: Workspace Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items: {}
                title: Response List Workspace Tutorials Api V3 Workspaces  Workspace Name  Tutorials Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
  /api/v3/workspaces/{workspace_name}/tutorials/{tutorial_name}:
    get:
      tags:
      - tutorials
      summary: Get tutorial (deprecated)
      description: Tutorials feature is deprecated. Returns 404.
      operationId: get_workspace_tutorial_api_v3_workspaces__workspace_name__tutorials__tutorial_name__get
      parameters:
      - name: workspace_name
        in: path
        required: true
        schema:
          type: string
          title: Workspace Name
      - name: tutorial_name
        in: path
        required: true
        schema:
          type: string
          title: Tutorial Name
      responses:
        '404':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                title: Response Get Workspace Tutorial Api V3 Workspaces  Workspace Name  Tutorials  Tutorial Name  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - BearerAuth: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT access token from /api/v3/token/ or Auth0 login