generate_schema_config.py 4 KB
Newer Older
1 2
from formats import message_header
from formats.mission_plan import mission_plan_schema
3
from formats.mission_plan_encoded import mission_plan_encoded_schema
4
from formats.observation import observation_schema
5
from formats.observation_encoded import observation_encoded_schema
6
from formats.planning_configuration import planning_configuration_schema
7
from formats.platform_status import platform_status_schema
8
from formats.platform_status_encoded import platform_status_encoded_schema
9 10 11 12 13
from formats.acknowledgement import acknowledgement_schema

from flasgger import Swagger
from flask import Flask

14 15
import os

16 17
app = Flask(__name__)

James Kirk's avatar
James Kirk committed
18
url_prefix = os.getenv("URL_PREFIX", "")
19 20 21 22 23

swagger_config = {
    "openapi": "3.0.2",
    "swagger_ui": True,
    "specs_route": "/",
24
    "info": {
25 26
        "title": "SoAR Backbone Message Formats",
        "version": "1.0",
27
        "description": "SoAR message protocol in schemas",
28 29 30 31 32 33 34
    },
    "specs": [
        {
            "endpoint": "swagger",
            "route": "/soar_protocol.json",
        }
    ],
35
    "url_prefix": url_prefix,
36 37 38 39 40
    "paths": {},
    "components": {
        "schemas": {
            "MESSAGE": {
                "type": "object",
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
41 42 43
                "description": "Full message definition with"
                + " message-metadata in `header` and different"
                + " message type schemas under `payload`",
44 45 46 47
                "properties": {
                    "header": {
                        "$ref": "#/components/schemas/header",
                    },
48
                    "payload": {"$ref": "#/components/schemas/payload"},
49 50 51 52 53 54
                },
                "required": ["header", "payload"],
            },
            "payload": {
                "discriminator": {
                    "propertyName": "message_type",
55
                    "mapping": {
56
                        "mission_plan": "#/components/schemas/mission_plan",
57 58
                        "mission_plan_encoded": "#/components/schemas/"
                        + "mission_plan_encoded",
59
                        "observation": "#/components/schemas/observation",
60 61
                        "observation_encoded": "#/components/schemas/"
                        + "observation_encoded",
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
62 63
                        "planning_configuration": "#/components/schemas/"
                        + "planning_configuration",
64
                        "platform_status": "#/components/schemas/platform_status",
65 66
                        "platform_status_encoded": "#/components/schemas/"
                        + "platform_status_encoded",
67
                        "acknowledgement": "#/components/schemas/acknowledgement",
68 69
                    },
                },
70
                "oneOf": [
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
71 72
                    {"$ref": "#/components/schemas/acknowledgement"},
                    {"$ref": "#/components/schemas/mission_plan"},
73
                    {"$ref": "#/components/schemas/mission_plan_encoded"},
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
74
                    {"$ref": "#/components/schemas/observation"},
75
                    {"$ref": "#/components/schemas/observation_encoded"},
Trishna Saeharaseelan's avatar
Trishna Saeharaseelan committed
76 77
                    {"$ref": "#/components/schemas/planning_configuration"},
                    {"$ref": "#/components/schemas/platform_status"},
78
                    {"$ref": "#/components/schemas/platform_status_encoded"},
79
                ],
80 81 82
            },
            "header": message_header,
            "mission_plan": mission_plan_schema,
83
            "mission_plan_encoded": mission_plan_encoded_schema,
84
            "observation": observation_schema,
85
            "observation_encoded": observation_encoded_schema,
86
            "planning_configuration": planning_configuration_schema,
87
            "platform_status": platform_status_schema,
88
            "platform_status_encoded": platform_status_encoded_schema,
89 90 91 92 93 94 95
            "acknowledgement": acknowledgement_schema,
        }
    },
}

swag = Swagger(app, config=swagger_config, merge=True)

96 97
flask_host = os.getenv(
    "FLASK_HOST", "localhost"
98
)  # Sets to whatever FLASK_HOST is, or defaults to localhost
99 100

if __name__ == "__main__":
101
    app.run(debug=False, host=flask_host)