openapi.yaml

openapi: 3.0.3
info:
  title: Pitcher Analytics API
  description: |
    REST API for managing pitch analysis sessions, including uploading session summaries,
    retrieving pitch metrics, and accessing heatmap data.

    ## Authentication
    All endpoints require authentication via Azure Entra ID (AAD).
    Azure Static Web Apps handles authentication and passes user identity via headers.

    ## Rate Limiting
    - **Limit**: 100 requests per minute per user
    - **Headers**: Each response includes rate limit information
      - `X-RateLimit-Limit`: Maximum requests allowed
      - `X-RateLimit-Remaining`: Requests remaining in current window
      - `X-RateLimit-Reset`: Time when the limit resets (ISO 8601)
    - **429 Response**: Returned when limit is exceeded, includes `Retry-After` header
  version: 1.0.0
  contact:
    name: Pitcher Analytics Support
  license:
    name: MIT

servers:
  - url: /api
    description: API base path

tags:
  - name: sessions
    description: Session management and pitch data

paths:
  /sessions:
    get:
      summary: List all sessions
      description: Retrieves all pitch analysis sessions for the authenticated user
      operationId: getSessions
      tags:
        - sessions
      security:
        - azureAuth: []
      responses:
        '200':
          description: Successfully retrieved sessions
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      $ref: '#/components/schemas/SessionListItem'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'

    post:
      summary: Upload a new session
      description: Uploads a session summary with pitch data
      operationId: createSession
      tags:
        - sessions
      security:
        - azureAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SessionSummary'
      responses:
        '201':
          description: Session created successfully
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessionId:
                    type: string
                    description: Created session ID
                  pitchCount:
                    type: integer
                    description: Number of pitches in the session
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'

  /sessions/{session_id}:
    get:
      summary: Get session details
      description: Retrieves a specific session with all pitch data
      operationId: getSessionById
      tags:
        - sessions
      security:
        - azureAuth: []
      parameters:
        - name: session_id
          in: path
          required: true
          description: Session ID
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved session
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
          content:
            application/json:
              schema:
                type: object
                properties:
                  session:
                    $ref: '#/components/schemas/Session'
                  pitches:
                    type: array
                    items:
                      $ref: '#/components/schemas/Pitch'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
        '500':
          $ref: '#/components/responses/InternalServerError'

components:
  securitySchemes:
    azureAuth:
      type: http
      scheme: bearer
      description: Azure Entra ID (AAD) authentication via Azure Static Web Apps

  headers:
    X-RateLimit-Limit:
      description: Maximum number of requests allowed per minute
      schema:
        type: integer
        example: 100
    X-RateLimit-Remaining:
      description: Number of requests remaining in the current window
      schema:
        type: integer
        example: 95
    X-RateLimit-Reset:
      description: Time when the rate limit resets (ISO 8601 format)
      schema:
        type: string
        format: date-time
        example: "2026-01-16T12:30:00.000Z"

  schemas:
    SessionListItem:
      type: object
      description: Summary information for a session in list view
      properties:
        sessionId:
          type: string
          description: Unique session identifier
        sessionKey:
          type: string
          description: Azure Table Storage row key
        sessionName:
          type: string
          nullable: true
          description: Optional human-readable session name
        pitchCount:
          type: integer
          description: Total number of pitches in the session
        createdAt:
          type: string
          format: date-time
          description: Session creation timestamp
        startedAt:
          type: string
          format: date-time
          nullable: true
          description: When the session started (if provided)
      required:
        - sessionId
        - sessionKey
        - pitchCount
        - createdAt

    Session:
      type: object
      description: Complete session data including aggregated statistics
      properties:
        sessionId:
          type: string
          description: Unique session identifier
        sessionKey:
          type: string
          description: Azure Table Storage row key
        sessionName:
          type: string
          nullable: true
          description: Optional human-readable session name
        pitchCount:
          type: integer
          description: Total number of pitches
        strikes:
          type: integer
          nullable: true
          description: Number of strikes
        balls:
          type: integer
          nullable: true
          description: Number of balls
        heatmap:
          type: array
          nullable: true
          description: 3x3 heatmap grid for zone visualization
          items:
            type: array
            items:
              type: integer
        createdAt:
          type: string
          format: date-time
          description: Session creation timestamp
        startedAt:
          type: string
          format: date-time
          nullable: true
          description: When the session started
      required:
        - sessionId
        - sessionKey
        - pitchCount
        - createdAt

    Pitch:
      type: object
      description: Individual pitch metrics
      properties:
        pitchId:
          type: string
          description: Unique pitch identifier
        speed:
          type: number
          nullable: true
          description: Pitch speed in mph
        run:
          type: number
          nullable: true
          description: Horizontal movement in inches
        rise:
          type: number
          nullable: true
          description: Vertical movement in inches
        zone:
          type: integer
          nullable: true
          minimum: 1
          maximum: 9
          description: Strike zone location (1-9)
        zoneRow:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3
          description: Zone row (1-3)
        zoneCol:
          type: integer
          nullable: true
          minimum: 1
          maximum: 3
          description: Zone column (1-3)
        isStrike:
          type: boolean
          nullable: true
          description: Whether the pitch was a strike
      required:
        - pitchId

    SessionSummary:
      type: object
      description: Session summary payload for upload
      properties:
        session_id:
          type: string
          description: Unique session identifier (snake_case for input)
        session_name:
          type: string
          description: Optional session name
        started_at:
          type: string
          format: date-time
          description: When the session started
        pitch_count:
          type: integer
          description: Total number of pitches
        strikes:
          type: integer
          description: Number of strikes
        balls:
          type: integer
          description: Number of balls
        heatmap:
          type: array
          description: 3x3 heatmap grid
          items:
            type: array
            items:
              type: integer
        pitches:
          type: array
          description: Array of pitch data
          items:
            type: object
            properties:
              pitch_id:
                type: string
              speed_mph:
                type: number
              run_in:
                type: number
              rise_in:
                type: number
              zone_row:
                type: integer
                minimum: 1
                maximum: 3
              zone_col:
                type: integer
                minimum: 1
                maximum: 3
              is_strike:
                type: boolean
      required:
        - session_id
        - pitches

    Error:
      type: object
      description: Error response
      properties:
        error:
          type: string
          description: Error message
        details:
          type: array
          description: Detailed validation errors (if applicable)
          items:
            type: object
      required:
        - error

  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: "Unauthorized"

    BadRequest:
      description: Invalid request data
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: "Schema validation failed"
            details:
              - message: "must have required property 'session_id'"
                path: ""

    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: "Session not found"

    RateLimitExceeded:
      description: Rate limit exceeded
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          schema:
            type: integer
            example: 0
        X-RateLimit-Reset:
          $ref: '#/components/headers/X-RateLimit-Reset'
        Retry-After:
          description: Number of seconds to wait before retrying
          schema:
            type: integer
            example: 42
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: "Too many requests. Please try again later."
            retryAfter: 42

    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: "An internal server error occurred"