generate_schema_config.py 3.79 KB
Newer Older
1
from formats import message_header
2
from formats.encoded import encoded_schema
3 4 5
from formats.mission_plan import mission_plan_schema
from formats.observation import observation_schema
from formats.planning_configuration import planning_configuration_schema
6
from formats.platform_status import platform_status_schema
7 8 9 10 11
from formats.acknowledgement import acknowledgement_schema

from flasgger import Swagger
from flask import Flask

12 13
import os

14 15
app = Flask(__name__)

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

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

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

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

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