-
Notifications
You must be signed in to change notification settings - Fork 7
/
openapi.json
1 lines (1 loc) · 2.92 KB
/
openapi.json
1
{"openapi":"3.1.0","info":{"title":"ortelius-ms-textfile-crud","description":"RestAPI endpoint for retrieving SBOM data to a component","contact":{"name":"Ortelius Open Source Project","url":"https://github.com/ortelius/ortelius/issues","email":"[email protected]"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"version":"10.0.0"},"servers":[{"url":"http://localhost:5004","description":"Local Server"}],"paths":{"/health":{"get":{"tags":["health"],"summary":"Health","description":"This health check end point used by Kubernetes","operationId":"health_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusMsg"}}}}}}},"/msapi/textfile":{"get":{"tags":["textfile"],"summary":"Get File Content","operationId":"get_file_content_msapi_textfile_get","parameters":[{"name":"compid","in":"query","required":true,"schema":{"type":"integer","minimum":1,"title":"Compid"}},{"name":"filetype","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filetype"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["textfile-post"],"summary":"Save File Content","operationId":"save_file_content_msapi_textfile_post","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"FileRequest":{"properties":{"compid":{"type":"integer","title":"Compid","default":0},"filetype":{"type":"string","title":"Filetype","default":""},"file":{"items":{"type":"string"},"type":"array","title":"File","default":[]}},"type":"object","title":"FileRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"StatusMsg":{"properties":{"status":{"type":"string","title":"Status","default":""},"service_name":{"type":"string","title":"Service Name","default":""}},"type":"object","title":"StatusMsg"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"tags":[{"name":"health","description":"health check end point"},{"name":"textfile","description":"Retrieve the text file"},{"name":"textfile-post","description":"Save the text file"}]}