synchronik/agent-api-description.yml

46 lines
967 B
YAML
Raw Normal View History

---
openapi: "3.0.0"
info:
description: |
Janky Agent API defintion
version: "1.0.0"
title: Janky APIs
contact:
email: "rtyler+janky@brokenco.de"
license:
name: "AGPL v3.0"
url: "https://www.gnu.org/licenses/agpl-3.0.en.html"
servers:
- url: 'http://localhost:9000/api/v1'
description: Local dev agent (APIv1)
paths:
/capabilities:
get:
summary: "Retrieve a list of capabilities of this agent"
description:
responses:
200:
description: Getting capabilities
content:
application/json:
schema:
$ref: '#/components/schemas/CapsResponse'
components:
schemas:
CapsResponse:
type: array
properties:
caps:
$ref: '#/components/schemas/Capability'
Capability:
type: object
properties:
name:
type: string
path:
type: string
data:
type: object