synchronik/api-description-server.yml
R. Tyler Croy 19126ed88b
Refactor the project configuration to take in a github configuration
This allows for fetching the Jankyfile directly via REST API so the server
doesn't have to do any Git work just yet
2023-01-28 20:33:20 -08:00

34 lines
757 B
YAML

---
openapi: "3.0.0"
info:
description: |
Janky Server 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:8000/api/v1'
description: Local dev server (APIv1)
paths:
'/projects/{name}':
post:
summary: 'Trigger execution for this project'
description:
parameters:
- in: path
name: name
required: true
example: 'janky'
schema:
type: string
responses:
404:
summary: 'No project configured by that name'
200:
summary: 'Execution has been triggered'