135 lines
3.7 KiB
JSON
135 lines
3.7 KiB
JSON
{
|
|
"info": {
|
|
"description": "Anonymous read-only access to sanitized HOMELAB documents published in Gitea. This API has no write operations.",
|
|
"title": "HOMELAB Gitea Public Context",
|
|
"version": "1.0.0"
|
|
},
|
|
"openapi": "3.1.0",
|
|
"paths": {
|
|
"/bundle.json": {
|
|
"get": {
|
|
"description": "Returns a public read-only JSON bundle containing all documents listed by the sanitized Gitea context index. No authentication is required.",
|
|
"operationId": "getHomelabContextBundle",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Current sanitized HOMELAB context bundle"
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Read all sanitized HOMELAB context documents"
|
|
}
|
|
},
|
|
"/current/README.md": {
|
|
"get": {
|
|
"operationId": "getHomelabDocument_current_README_md",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"text/markdown": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "Contents of current/README.md"
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Read sanitized HOMELAB document current/README.md"
|
|
}
|
|
},
|
|
"/current/publication-policy.md": {
|
|
"get": {
|
|
"operationId": "getHomelabDocument_current_publication_policy_md",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"text/markdown": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "Contents of current/publication-policy.md"
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Read sanitized HOMELAB document current/publication-policy.md"
|
|
}
|
|
},
|
|
"/current/state.json": {
|
|
"get": {
|
|
"operationId": "getHomelabDocument_current_state_json",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Contents of current/state.json"
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Read sanitized HOMELAB document current/state.json"
|
|
}
|
|
},
|
|
"/current/summary.md": {
|
|
"get": {
|
|
"operationId": "getHomelabDocument_current_summary_md",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"text/markdown": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"description": "Contents of current/summary.md"
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "Read sanitized HOMELAB document current/summary.md"
|
|
}
|
|
},
|
|
"/index.json": {
|
|
"get": {
|
|
"operationId": "getHomelabContextIndex",
|
|
"responses": {
|
|
"200": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"additionalProperties": true,
|
|
"type": "object"
|
|
}
|
|
}
|
|
},
|
|
"description": "Public context index"
|
|
}
|
|
},
|
|
"security": [],
|
|
"summary": "List sanitized HOMELAB context documents"
|
|
}
|
|
}
|
|
},
|
|
"security": [],
|
|
"servers": [
|
|
{
|
|
"url": "https://git.gram1.ru/homelab-admin/homelab-public-context/raw/branch/main"
|
|
}
|
|
]
|
|
}
|