mirror of
https://github.com/sartography/uva-covid19-testing-communicator.git
synced 2025-02-24 12:58:05 +00:00
54 lines
1.5 KiB
YAML
54 lines
1.5 KiB
YAML
openapi: "3.0.2"
|
|
info:
|
|
version: 1.0.0
|
|
title: Workflow Microservice
|
|
license:
|
|
name: MIT
|
|
servers:
|
|
- url: http://localhost:5000/v1.0
|
|
security:
|
|
- jwt: ['secret']
|
|
paths:
|
|
/status:
|
|
get:
|
|
operationId: communicator.api.admin.status
|
|
summary: provides a basic status endpoint, just get things off the ground.
|
|
security: [] # Disable security for this endpoint only.
|
|
responses:
|
|
'200':
|
|
description: Status indicator that the app is up and alive.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/Status"
|
|
/update_data:
|
|
get:
|
|
operationId: communicator.api.admin.update_data
|
|
summary: Checks the local file system and firecloud for data and loads it into the db.
|
|
security: [] # Disable security for this endpoint only.
|
|
responses:
|
|
'200':
|
|
description: Status indicator that the app is up and alive.
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
/notify_by_email:
|
|
get:
|
|
operationId: communicator.api.admin.notify_by_email
|
|
summary: when called, reviews all samples, and sends out any pending notifications.
|
|
security: [] # Disable security for this endpoint only.
|
|
responses:
|
|
'200':
|
|
description: Just returns a 200 if it was successful.
|
|
content:
|
|
text/plain:
|
|
schema:
|
|
type: string
|
|
|
|
components:
|
|
schemas:
|
|
Status:
|
|
properties:
|
|
status:
|
|
type: string |