profilarr/docs/api/v1/openapi.yaml

openapi: 3.1.0
info:
  title: Profilarr API
  description: API for Profilarr - Profile management and sync for *arr applications
  version: 1.0.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT

servers:
  - url: /api/v1
    description: API v1

tags:
  - name: System
    description: System health and status endpoints
  - name: Entity Testing
    description: Release parsing and custom format evaluation
  - name: Arr
    description: Arr instance management, library, and sync endpoints
  - name: PCD
    description: PCD entity export and portable format endpoints
  - name: Databases
    description: Linked database instance management
  - name: Regex
    description: Regex pattern validation

paths:
  /arr:
    $ref: './paths/arr.yaml#/instances'
  /databases:
    $ref: './paths/databases.yaml#/databases'
  /health:
    $ref: './paths/system.yaml#/health'
  /health/diagnostics:
    $ref: './paths/system.yaml#/health_diagnostics'
  /openapi.json:
    $ref: './paths/system.yaml#/openapi'
  /entity-testing/evaluate:
    $ref: './paths/entity-testing.yaml#/evaluate'
  /arr/library:
    $ref: './paths/arr.yaml#/library'
  /arr/library/episodes:
    $ref: './paths/arr.yaml#/episodes'
  /arr/releases:
    $ref: './paths/arr.yaml#/releases'
  /arr/cleanup:
    $ref: './paths/arr.yaml#/cleanup'
  /arr/sync-entity:
    $ref: './paths/arr.yaml#/sync-entity'
  /pcd/export:
    $ref: './paths/pcd.yaml#/export'
  /pcd/import:
    $ref: './paths/pcd.yaml#/import'
  /regex/validate:
    $ref: './paths/regex.yaml#/validate'

components:
  schemas:
    # Common
    ComponentStatus:
      $ref: './schemas/common.yaml#/ComponentStatus'
    HealthStatus:
      $ref: './schemas/common.yaml#/HealthStatus'
    # Health
    HealthCheckResponse:
      $ref: './schemas/health.yaml#/HealthCheckResponse'
    HealthDiagnosticsResponse:
      $ref: './schemas/health.yaml#/HealthDiagnosticsResponse'
    # Entity Testing
    MediaType:
      $ref: './schemas/entity-testing.yaml#/MediaType'
    ParsedInfo:
      $ref: './schemas/entity-testing.yaml#/ParsedInfo'
    ReleaseInput:
      $ref: './schemas/entity-testing.yaml#/ReleaseInput'
    ReleaseEvaluation:
      $ref: './schemas/entity-testing.yaml#/ReleaseEvaluation'
    EvaluateRequest:
      $ref: './schemas/entity-testing.yaml#/EvaluateRequest'
    EvaluateResponse:
      $ref: './schemas/entity-testing.yaml#/EvaluateResponse'
    # Arr - Shared
    ArrType:
      $ref: './schemas/arr.yaml#/ArrType'
    CustomFormatRef:
      $ref: './schemas/arr.yaml#/CustomFormatRef'
    ScoreBreakdownItem:
      $ref: './schemas/arr.yaml#/ScoreBreakdownItem'
    ProfileByDatabase:
      $ref: './schemas/arr.yaml#/ProfileByDatabase'
    ErrorResponse:
      $ref: './schemas/arr.yaml#/ErrorResponse'
    # Arr - Library
    RadarrLibraryItem:
      $ref: './schemas/arr.yaml#/RadarrLibraryItem'
    SonarrSeasonItem:
      $ref: './schemas/arr.yaml#/SonarrSeasonItem'
    SonarrLibraryItem:
      $ref: './schemas/arr.yaml#/SonarrLibraryItem'
    SonarrEpisodeItem:
      $ref: './schemas/arr.yaml#/SonarrEpisodeItem'
    LibraryResponse:
      $ref: './schemas/arr.yaml#/LibraryResponse'
    EpisodesResponse:
      $ref: './schemas/arr.yaml#/EpisodesResponse'
    CacheInvalidatedResponse:
      $ref: './schemas/arr.yaml#/CacheInvalidatedResponse'
    # Arr - Releases
    GroupedRelease:
      $ref: './schemas/arr.yaml#/GroupedRelease'
    ReleasesResponse:
      $ref: './schemas/arr.yaml#/ReleasesResponse'
    # Arr - Cleanup
    StaleItem:
      $ref: './schemas/arr.yaml#/StaleItem'
    CleanupScanRequest:
      $ref: './schemas/arr.yaml#/CleanupScanRequest'
    CleanupExecuteRequest:
      $ref: './schemas/arr.yaml#/CleanupExecuteRequest'
    CleanupScanResult:
      $ref: './schemas/arr.yaml#/CleanupScanResult'
    CleanupDeleteResult:
      $ref: './schemas/arr.yaml#/CleanupDeleteResult'
    # Arr - Sync Entity
    SyncEntityRequest:
      $ref: './schemas/arr.yaml#/SyncEntityRequest'
    SyncEntitySuccessResponse:
      $ref: './schemas/arr.yaml#/SyncEntitySuccessResponse'
    SyncEntityCooldownResponse:
      $ref: './schemas/arr.yaml#/SyncEntityCooldownResponse'
    # PCD
    EntityType:
      $ref: './schemas/pcd.yaml#/EntityType'
    ExportResponse:
      $ref: './schemas/pcd.yaml#/ExportResponse'
    PcdErrorResponse:
      $ref: './schemas/pcd.yaml#/PcdErrorResponse'
    BundledDependency:
      $ref: './schemas/pcd.yaml#/BundledDependency'
    ImportConflict:
      $ref: './schemas/pcd.yaml#/ImportConflict'
    ConflictResolution:
      $ref: './schemas/pcd.yaml#/ConflictResolution'
    ImportRequest:
      $ref: './schemas/pcd.yaml#/ImportRequest'
    ImportResponse:
      $ref: './schemas/pcd.yaml#/ImportResponse'
    # Arr
    ArrInstance:
      $ref: './schemas/arr.yaml#/ArrInstance'
    # Databases
    DatabaseInstance:
      $ref: './schemas/databases.yaml#/DatabaseInstance'
    # Regex
    ValidateRegexRequest:
      $ref: './schemas/regex.yaml#/ValidateRegexRequest'
    ValidateRegexResponse:
      $ref: './schemas/regex.yaml#/ValidateRegexResponse'