> ## Documentation Index
> Fetch the complete documentation index at: https://docs.oktolabs.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Sprint

> Update a sprint.



## OpenAPI

````yaml /openapi.json patch /api/v1/sprints/{sprint_id}
openapi: 3.1.0
info:
  description: >-
    Okto Pulse REST API schema generated from okto-pulse-core 0.2.0 source for
    docs.oktolabs.ai.
  title: Okto Pulse
  version: 0.2.0
servers: []
security: []
paths:
  /api/v1/sprints/{sprint_id}:
    patch:
      tags:
        - sprints
      summary: Update Sprint
      description: Update a sprint.
      operationId: update_sprint_api_v1_sprints__sprint_id__patch
      parameters:
        - in: path
          name: sprint_id
          required: true
          schema:
            title: Sprint Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SprintUpdate'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SprintResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - HTTPBearer: []
components:
  schemas:
    SprintUpdate:
      description: Schema for updating a sprint.
      properties:
        business_rule_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Business Rule Ids
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        end_date:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: End Date
        expected_outcome:
          anyOf:
            - type: string
            - type: 'null'
          title: Expected Outcome
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        objective:
          anyOf:
            - type: string
            - type: 'null'
          title: Objective
        skip_qualitative_validation:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Skip Qualitative Validation
        skip_rules_coverage:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Skip Rules Coverage
        skip_test_coverage:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Skip Test Coverage
        start_date:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Start Date
        test_scenario_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Test Scenario Ids
        title:
          anyOf:
            - maxLength: 500
              minLength: 1
              type: string
            - type: 'null'
          title: Title
        validation_threshold:
          anyOf:
            - type: integer
            - type: 'null'
          title: Validation Threshold
      title: SprintUpdate
      type: object
    SprintResponse:
      description: Schema for full sprint response.
      properties:
        archived:
          default: false
          title: Archived
          type: boolean
        board_id:
          title: Board Id
          type: string
        business_rule_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Business Rule Ids
        cards:
          default: []
          items:
            $ref: '#/components/schemas/CardSummaryForSpec'
          title: Cards
          type: array
        created_at:
          format: date-time
          title: Created At
          type: string
        created_by:
          title: Created By
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        end_date:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: End Date
        evaluations:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Evaluations
        expected_outcome:
          anyOf:
            - type: string
            - type: 'null'
          title: Expected Outcome
        id:
          title: Id
          type: string
        labels:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Labels
        objective:
          anyOf:
            - type: string
            - type: 'null'
          title: Objective
        pre_archive_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Pre Archive Status
        qa_items:
          default: []
          items:
            $ref: '#/components/schemas/SprintQAResponse'
          title: Qa Items
          type: array
        skip_qualitative_validation:
          default: false
          title: Skip Qualitative Validation
          type: boolean
        skip_rules_coverage:
          default: false
          title: Skip Rules Coverage
          type: boolean
        skip_test_coverage:
          default: false
          title: Skip Test Coverage
          type: boolean
        spec_id:
          title: Spec Id
          type: string
        spec_version:
          title: Spec Version
          type: integer
        start_date:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Start Date
        status:
          $ref: '#/components/schemas/SprintStatus'
        test_scenario_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Test Scenario Ids
        title:
          title: Title
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
        validation_threshold:
          anyOf:
            - type: integer
            - type: 'null'
          title: Validation Threshold
        version:
          title: Version
          type: integer
      required:
        - id
        - spec_id
        - board_id
        - title
        - status
        - spec_version
        - version
        - created_by
        - created_at
        - updated_at
      title: SprintResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CardSummaryForSpec:
      description: Minimal card summary used inside spec responses.
      properties:
        assignee_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Assignee Id
        id:
          title: Id
          type: string
        priority:
          $ref: '#/components/schemas/CardPriority'
        sprint_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Sprint Id
        status:
          $ref: '#/components/schemas/CardStatus'
        title:
          title: Title
          type: string
      required:
        - id
        - title
        - status
        - priority
        - assignee_id
      title: CardSummaryForSpec
      type: object
    SprintQAResponse:
      description: Schema for sprint Q&A item response.
      properties:
        allow_free_text:
          default: false
          title: Allow Free Text
          type: boolean
        answer:
          anyOf:
            - type: string
            - type: 'null'
          title: Answer
        answered_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          title: Answered At
        answered_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Answered By
        asked_by:
          title: Asked By
          type: string
        choices:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Choices
        created_at:
          format: date-time
          title: Created At
          type: string
        id:
          title: Id
          type: string
        question:
          title: Question
          type: string
        question_type:
          title: Question Type
          type: string
        selected:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Selected
        sprint_id:
          title: Sprint Id
          type: string
      required:
        - id
        - sprint_id
        - question
        - question_type
        - asked_by
        - created_at
      title: SprintQAResponse
      type: object
    SprintStatus:
      description: Sprint lifecycle status.
      enum:
        - draft
        - active
        - review
        - closed
        - cancelled
      title: SprintStatus
      type: string
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    CardPriority:
      description: Card priority levels.
      enum:
        - critical
        - very_high
        - high
        - medium
        - low
        - none
      title: CardPriority
      type: string
    CardStatus:
      description: Card status enum matching Kanban columns.
      enum:
        - not_started
        - started
        - in_progress
        - validation
        - on_hold
        - done
        - cancelled
      title: CardStatus
      type: string
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http

````