diff --git a/formats/encoded.py b/formats/encoded.py index 02069b6083331f6ebb3c5ac0d185479bfbc9907c..8d6d700686a0db7797b070a28a73f46cd04a91c7 100644 --- a/formats/encoded.py +++ b/formats/encoded.py @@ -12,12 +12,6 @@ encoded_schema = { "message_type": { "type": "string", "description": "Type of message", - "example": "mission_plan", - "enum": [ - "mission_plan_encoded", - "observation_encoded", - "platform_status_encoded", - ], }, "data": { "type": "string", diff --git a/formats/mission_plan_encoded.py b/formats/mission_plan_encoded.py new file mode 100644 index 0000000000000000000000000000000000000000..bc32ab4f0921816ca33ccbd6a327c6403973ba6d --- /dev/null +++ b/formats/mission_plan_encoded.py @@ -0,0 +1,10 @@ +from formats.encoded import encoded_schema + +mission_plan_encoded_schema = encoded_schema + +mission_plan_encoded_schema["properties"]["message_type"]["enum"] = [ + "mission_plan_encoded" +] +mission_plan_encoded_schema["properties"]["message_type"][ + "example" +] = "mission_plan_encoded" diff --git a/formats/observation_encoded.py b/formats/observation_encoded.py new file mode 100644 index 0000000000000000000000000000000000000000..257c21a7a55703f0cc55cc69da6bb4a62d606576 --- /dev/null +++ b/formats/observation_encoded.py @@ -0,0 +1,10 @@ +from formats.encoded import encoded_schema + +observation_encoded_schema = encoded_schema + +observation_encoded_schema["properties"]["message_type"]["enum"] = [ + "observation_encoded" +] +observation_encoded_schema["properties"]["message_type"][ + "example" +] = "observation_encoded" diff --git a/formats/platform_status_encoded.py b/formats/platform_status_encoded.py new file mode 100644 index 0000000000000000000000000000000000000000..23b54a9a9cb28f228c4781a481c7318c294185dc --- /dev/null +++ b/formats/platform_status_encoded.py @@ -0,0 +1,10 @@ +from formats.encoded import encoded_schema + +platform_status_encoded_schema = encoded_schema + +platform_status_encoded_schema["properties"]["message_type"]["enum"] = [ + "platform_status_encoded" +] +platform_status_encoded_schema["properties"]["message_type"][ + "example" +] = "platform_status_encoded" diff --git a/generate_schema_config.py b/generate_schema_config.py index 51f081fb971211432eaaf3b6b239072ca79277d4..52fd78655834b32c75115b766d97cb664bde9712 100644 --- a/generate_schema_config.py +++ b/generate_schema_config.py @@ -1,9 +1,11 @@ from formats import message_header -from formats.encoded import encoded_schema from formats.mission_plan import mission_plan_schema +from formats.mission_plan_encoded import mission_plan_encoded_schema from formats.observation import observation_schema +from formats.observation_encoded import observation_encoded_schema from formats.planning_configuration import planning_configuration_schema from formats.platform_status import platform_status_schema +from formats.platform_status_encoded import platform_status_encoded_schema from formats.acknowledgement import acknowledgement_schema from flasgger import Swagger @@ -78,12 +80,12 @@ swagger_config = { }, "header": message_header, "mission_plan": mission_plan_schema, - "mission_plan_encoded": encoded_schema, + "mission_plan_encoded": mission_plan_encoded_schema, "observation": observation_schema, - "observation_encoded": encoded_schema, + "observation_encoded": observation_encoded_schema, "planning_configuration": planning_configuration_schema, "platform_status": platform_status_schema, - "platform_status_encoded": encoded_schema, + "platform_status_encoded": platform_status_encoded_schema, "acknowledgement": acknowledgement_schema, } }, diff --git a/project/soar/swagger.json b/project/soar/swagger.json index 0b4be39077f96eb0c4d4716dfaa6ecc90ae4abd3..cbb07a5a46143c043c8bee223436e0bc423e0834 100644 --- a/project/soar/swagger.json +++ b/project/soar/swagger.json @@ -196,7 +196,7 @@ "mission_plan_encoded":{ "properties":{ "data":{ - "description":"Encoded string. E.g.: base64 encoded", + "description":"encoded string. E.g. Base64 encoded", "example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==", "type":"string" }, @@ -213,11 +213,9 @@ "message_type":{ "description":"Type of message", "enum":[ - "mission_plan_encoded", - "observation_encoded", - "platform_status_encoded" + "mission_plan_encoded" ], - "example":"mission_plan", + "example":"mission_plan_encoded", "type":"string" }, "mime_type":{ @@ -299,7 +297,7 @@ "observation_encoded":{ "properties":{ "data":{ - "description":"Encoded string. E.g. base64 encoding", + "description":"encoded string. E.g. Base64 encoded", "example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==", "type":"string" }, @@ -316,11 +314,9 @@ "message_type":{ "description":"Type of message", "enum":[ - "mission_plan_encoded", - "observation_encoded", - "platform_status_encoded" + "observation_encoded" ], - "example":"mission_plan", + "example":"observation_encoded", "type":"string" }, "mime_type":{ @@ -782,7 +778,7 @@ "platform_status_encoded":{ "properties":{ "data":{ - "description":"Encoded string. E.g. base64 encoding", + "description":"encoded string. E.g. Base64 encoded", "example":"SDQke4uwyP/YQQAgAhA2AND/nu8nvQAAAAAAAAAACtejPa5HHUGkcBAAAAIAAAAQAAAAAAAAAA9P2cP166ab+9cg==", "type":"string" }, @@ -799,11 +795,9 @@ "message_type":{ "description":"Type of message", "enum":[ - "mission_plan_encoded", - "observation_encoded", "platform_status_encoded" ], - "example":"mission_plan", + "example":"platform_status_encoded", "type":"string" }, "mime_type":{ diff --git a/tests-js/soar-examples.test.js b/tests-js/soar-examples.test.js index ce5f341c2c58b28feed2bd766793941556a971dc..7c0ec71583fc83bcd80ac9ca17535979129fcfce 100644 --- a/tests-js/soar-examples.test.js +++ b/tests-js/soar-examples.test.js @@ -3,7 +3,7 @@ const Validator = require('swagger-model-validator'); const OpenAPISchemaValidator = require('openapi-schema-validator').default; const getSchema = () => { - const schema = require(`${__dirname}/../projects/soar/swagger.json`); + const schema = require(`${__dirname}/../project/soar/swagger.json`); return schema; };