# Planekeeper API Parameters
# This file contains all shared parameter definitions for the OpenAPI specification

JobId:
  name: id
  in: path
  required: true
  description: The job ID
  schema:
    type: integer
    format: int64
    minimum: 1
    example: 123

## updated this to be in path instead of header to avoid codegen issue with only one header being required
AgentUUID:
  name: AgentUUID
  in: path
  required: true
  description: The agent's unique identifier
  schema:
    type: string
    format: uuid
    example: 550e8400-e29b-41d4-a716-446655440000

Limit:
  name: limit
  in: query
  description: Maximum number of items to return (1-100, default 50)
  schema:
    type: integer
    format: int32
    minimum: 1
    maximum: 100
    default: 50

Offset:
  name: offset
  in: query
  description: Number of items to skip for pagination
  schema:
    type: integer
    format: int32
    minimum: 0
    default: 0

SortOrder:
  name: sort
  in: query
  description: Sort order for date-based fields (default desc for newest first)
  schema:
    type: string
    enum: [asc, desc]
    default: desc
    example: desc

Scope:
  name: scope
  in: query
  description: Filter by job scope (org, global, or all). Default is all.
  schema:
    type: string
    enum: [org, global, all]
    default: all

UserId:
  name: id
  in: path
  required: true
  description: The user ID
  schema:
    type: integer
    format: int64
    minimum: 1
    example: 42