Skip to content

Commit

Permalink
Add the OAS3 spec
Browse files Browse the repository at this point in the history
  • Loading branch information
penguineer committed Nov 2, 2024
1 parent 17dea11 commit 00140a2
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions src/OAS3.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
openapi: 3.0.0
info:
title: Netz39 Ampel Controller API
description: Microservice to provide the Controller for our Traffic Light and Space Status.
version: 1.0.0
servers:
- url: http://localhost:8080
description: Local server
paths:
/v0/health:
get:
summary: Get health status
description: Returns the health status of the application.
responses:
'200':
description: A JSON object containing the health status.
content:
application/json:
schema:
type: object
properties:
api_version:
type: string
git_version:
type: string
timestamp:
type: string
format: date-time
uptime:
type: string
/v0/oas3:
get:
summary: Get OpenAPI 3.0 specification
description: Returns the OpenAPI 3.0 specification in plain text format.
responses:
'200':
description: The OpenAPI 3.0 specification.
content:
text/plain:
schema:
type: string

0 comments on commit 00140a2

Please sign in to comment.