mirror of
https://github.com/Dictionarry-Hub/profilarr.git
synced 2026-01-23 03:11:01 +01:00
456ecc298b
- Implemented health check endpoint to monitor application status and components. - Added OpenAPI specification endpoint to serve the API documentation. - Introduced new TypeScript definitions for API paths and components.
32 lines
698 B
YAML
32 lines
698 B
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
|
|
|
|
paths:
|
|
/health:
|
|
$ref: './paths/system.yaml#/health'
|
|
/openapi.json:
|
|
$ref: './paths/system.yaml#/openapi'
|
|
|
|
components:
|
|
schemas:
|
|
ComponentStatus:
|
|
$ref: './schemas/common.yaml#/ComponentStatus'
|
|
HealthStatus:
|
|
$ref: './schemas/common.yaml#/HealthStatus'
|
|
HealthResponse:
|
|
$ref: './schemas/health.yaml#/HealthResponse'
|