skill-http 0.3.0

HTTP streaming server for Skill - REST API and web interface support
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! OpenAPI specification generation for the Skill HTTP API
//!
//! This module provides OpenAPI 3.1 documentation for all REST endpoints using utoipa.

use utoipa::OpenApi;

use crate::types::*;

/// OpenAPI documentation for the Skill Engine HTTP API
#[derive(OpenApi)]
#[openapi(
    info(
        title = "Skill Engine API",
        version = "0.3.0",
        description = "REST API for managing and executing AI agent skills",
        license(
            name = "Apache-2.0",
            url = "https://www.apache.org/licenses/LICENSE-2.0"
        ),
        contact(
            name = "Skill Engine",
            url = "https://github.com/kubiyabot/skill"
        )
    ),
    servers(
        (url = "http://localhost:3000/api", description = "Local development server"),
        (url = "https://api.skill-engine.dev/api", description = "Production API")
    ),
    components(
        schemas(
            SkillSummary,
            SkillDetail,
            ToolInfo,
            ParameterInfo,
            InstanceInfo,
            InstallSkillRequest,
            InstallSkillResponse,
            ExecutionRequest,
            ExecutionResponse,
            ExecutionStatus,
            ExecutionHistoryEntry,
            SearchRequest,
            SearchResult,
            SearchResponse,
            QueryInfo,
            SearchConfigResponse,
            UpdateSearchConfigRequest,
            AppConfig,
            UpdateAppConfigRequest,
            HealthResponse,
            ComponentHealth,
            VersionResponse,
            ApiError,
            PaginationParams,
            ImportManifestRequest,
            ImportManifestResponse,
            ValidateManifestRequest,
            ValidateManifestResponse,
            ExportManifestRequest,
            ExportManifestResponse,
            ServiceStatus,
            ServicesStatusResponse,
            StartServiceRequest,
            StartServiceResponse,
            StopServiceRequest,
            SkillServiceRequirement,
            ParsedSkill,
            ParsedInstance,
            DockerConfig,
        )
    ),
    tags(
        (name = "skills", description = "Skill management operations"),
        (name = "execution", description = "Tool execution operations"),
        (name = "search", description = "Semantic search operations"),
        (name = "config", description = "Configuration management"),
        (name = "services", description = "System service management"),
        (name = "manifest", description = "Manifest import/export operations"),
        (name = "system", description = "System health and version"),
    )
)]
pub struct ApiDoc;

/// Generate the OpenAPI specification as JSON
pub fn generate_openapi_json() -> String {
    ApiDoc::openapi().to_pretty_json().expect("Failed to serialize OpenAPI spec")
}