Skip to content

GitLab

Merged
Created by Trishna Saeharaseelan@trishnaOwner

Create initial message schemas

Compare
and
6 files
+ 37
- 34
Show latest version
for‎mats‎
acknowled‎gement.py‎ +1 -1
mission‎_plan.py‎ +1 -1
observa‎tion.py‎ +1 -1
planning_con‎figuration.py‎ +1 -1
platform_‎status.py‎ +1 -1
generate_‎swagger.py‎ +32 -29
formats/acknowledgement.py
+ 1
- 1
Show all unchanged lines Show 20 lines
acknowledgement_schema = {
"allOf": [{"$ref": "#/definitions/Message"}],
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"acknowledged_message_ID": {
Show 20 lines Show all unchanged lines
formats/mission_plan.py
+ 1
- 1
Show all unchanged lines Show 20 lines
}
mission_plan_schema = {
"allOf": [{"$ref": "#/definitions/Message"}],
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"autonomy_engine_plan_ID": {
Show 20 lines Show all unchanged lines
formats/observation.py
+ 1
- 1
Show all unchanged lines Show 20 lines
}
observation_schema = {
"allOf": [{"$ref": "#/definitions/Message"}],
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"platform_ID": {
Show 20 lines Show all unchanged lines
formats/planning_configuration.py
+ 1
- 1
Show all unchanged lines Show 20 lines
}
planning_configuration_schema = {
"allOf": [{"$ref": "#/definitions/Message"}],
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"planning_config_ID": {
Show 20 lines Show all unchanged lines
formats/platform_status.py
+ 1
- 1
Show all unchanged lines Show 20 lines
}
platform_status_message_schema = {
"allOf": [{"$ref": "#/definitions/Message"}],
"allOf": [{"$ref": "#/components/schemas/Message"}],
"type": "object",
"properties": {
"platform_ID": {
Show 20 lines Show all unchanged lines
generate_swagger.py
+ 32
- 29
Show all unchanged lines Show 20 lines
from flasgger import Swagger
from flask import Flask
# from openapi_schema_validator import validate
from openapi_spec_validator import validate_spec_url
app = Flask(__name__)
swagger_config = {
"headers": [],
"openapi": "3.1",
"openapi": "3.0.2",
"swagger_ui": True,
"specs_route": "/",
"info": {
Show 20 lines Show all unchanged lines Show 20 lines
"model_filter": lambda tag: True,
}
],
"definitions": {
"Message": message_wrapper_schema,
"MissionPlan": mission_plan_schema,
"Observation": observation_schema,
"PlanningConfiguration": planning_configuration_schema,
"PlatformStatus": platform_status_message_schema,
"Acknowledgement": acknowledgement_schema,
"components": {
"schemas": {
"Message": message_wrapper_schema,
"MissionPlan": mission_plan_schema,
"Observation": observation_schema,
"PlanningConfiguration": planning_configuration_schema,
"PlatformStatus": platform_status_message_schema,
"Acknowledgement": acknowledgement_schema,
}
},
"paths": {
"/all_messages": {
Show 20 lines Show all unchanged lines Show 20 lines
"application/json": {
"schema": {
"oneOf": [
{"$ref": "#/definitions/Acknowledgement"},
{"$ref": "#/definitions/PlatformStatus"},
{"$ref": "#/definitions/MissionPlan"},
{"$ref": "#/definitions/Observation"},
{
"$ref": "#/definitions/PlanningConfiguration"
"$ref": "#/components/schemas/"
+ "Acknowledgement"
},
{
"$ref": "#/components/schemas/"
+ "MissionPlan"
},
{
"$ref": "#/components/schemas/"
+ "Observation"
},
{
"$ref": "#/components/schemas/"
+ "PlanningConfiguration"
},
{
"$ref": "#/components/schemas/"
+ "PlatformStatus"
},
{"$ref": "#/definitions/PlatformStatus"},
],
"discriminator": {
"propertyName": "message_type",
Show 20 lines Show all unchanged lines Show 20 lines
"schema": {
"allOf": [
{
"$ref": "#/definitions/" + item,
"$ref": "#/components/schemas/" + item,
},
],
"discriminator": {
Show 20 lines Show all unchanged lines Show 20 lines
swag = Swagger(app, config=swagger_config, merge=True)
# validate({"acknowledged_message_ID": "string-type-id", "status": "c2_received"}, acknowledgement_schema)
# app.add_url_rule(
# '/coordinates',
# view_func=Coordinates.as_view('coordinates'),
# methods=['GET']
# )
from openapi_spec_validator import validate_spec, openapi_v3_spec_validator
if __name__ == "__main__":
app.run(debug=True)
# print(validate_spec_url("http://127.0.0.1:5000/swagger.json"))
# If no exception is raised by validate_spec(), the spec is valid.
# # If no exception is raised by validate_spec(), the spec is valid.
# validate_spec(swagger_config)
# print("000 Schema validation passed")
# errors_iterator = openapi_v3_spec_validator.iter_errors(swagger_config)
# print(errors_iterator)
\ No newline at end of file
# print(errors_iterator)