diff --git a/docs/controllers/ServerController.yaml b/docs/controllers/ServerController.yaml new file mode 100644 index 00000000..09ed1ebf --- /dev/null +++ b/docs/controllers/ServerController.yaml @@ -0,0 +1,30 @@ +paths: + /ping: + get: + operationId: ping + summary: Ping the server + description: This endpoint is a simple check to see if the server is operating and responding with JSON correctly. + tags: + - Server + responses: + 200: + description: ping OK + content: + application/json: + schema: + type: object + properties: + success: + type: boolean + example: true + /healthcheck: + get: + operationId: healthcheck + summary: Health check + description: This endpoint is a simple check to see if the server is operating and can respond. + tags: + - Server + responses: + 200: + description: healthcheck OK + content: {} \ No newline at end of file diff --git a/docs/root.yaml b/docs/root.yaml index 4d6c055d..275f3028 100644 --- a/docs/root.yaml +++ b/docs/root.yaml @@ -15,6 +15,8 @@ components: security: - BearerAuth: [] paths: + /ping: + $ref: './controllers/ServerCONTROLLER.yaml#/paths/~1ping' /api/authors/{id}: $ref: './controllers/AuthorController.yaml#/paths/~1api~1authors~1{id}' /api/authors/{id}/image: @@ -90,3 +92,5 @@ tags: description: Notifications endpoints - name: Podcasts description: Podcast endpoints + - name: Server + description: Server endpoints