-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathspecification-openapi.json
More file actions
1 lines (1 loc) · 6.26 KB
/
specification-openapi.json
File metadata and controls
1 lines (1 loc) · 6.26 KB
1
{"openapi":"3.1.0","info":{"title":"Specification Service","description":"Service for managing product technical specifications","version":"0.1.0"},"paths":{"/health":{"get":{"summary":"Health Check","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/specifications":{"post":{"summary":"Create Specification","operationId":"create_specification_api_v1_specifications_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"public_key","in":"query","required":false,"schema":{"type":"string","title":"Public Key"}},{"name":"algorithm","in":"query","required":false,"schema":{"type":"string","default":"RS256","title":"Algorithm"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecificationCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecificationRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"List Specifications","operationId":"list_specifications_api_v1_specifications_get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":1000,"minimum":1,"default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SpecificationRead"},"title":"Response List Specifications Api V1 Specifications Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/specifications/{spec_id}":{"get":{"summary":"Get Specification","operationId":"get_specification_api_v1_specifications__spec_id__get","parameters":[{"name":"spec_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Spec Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecificationRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Specification","operationId":"update_specification_api_v1_specifications__spec_id__put","security":[{"HTTPBearer":[]}],"parameters":[{"name":"spec_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Spec Id"}},{"name":"public_key","in":"query","required":false,"schema":{"type":"string","title":"Public Key"}},{"name":"algorithm","in":"query","required":false,"schema":{"type":"string","default":"RS256","title":"Algorithm"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecificationUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpecificationRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Specification","operationId":"delete_specification_api_v1_specifications__spec_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"spec_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Spec Id"}},{"name":"public_key","in":"query","required":false,"schema":{"type":"string","title":"Public Key"}},{"name":"algorithm","in":"query","required":false,"schema":{"type":"string","default":"RS256","title":"Algorithm"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/specifications/validate":{"post":{"summary":"Validate Specifications","operationId":"validate_specifications_api_v1_specifications_validate_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"public_key","in":"query","required":false,"schema":{"type":"string","title":"Public Key"}},{"name":"algorithm","in":"query","required":false,"schema":{"type":"string","default":"RS256","title":"Algorithm"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Spec Ids"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SpecificationCreate":{"properties":{"name":{"type":"string","title":"Name"},"characteristic_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Characteristic Ids"}},"type":"object","required":["name","characteristic_ids"],"title":"SpecificationCreate"},"SpecificationRead":{"properties":{"name":{"type":"string","title":"Name"},"characteristic_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Characteristic Ids"},"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["name","characteristic_ids","id","created_at","updated_at"],"title":"SpecificationRead"},"SpecificationUpdate":{"properties":{"name":{"type":"string","title":"Name"},"characteristic_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Characteristic Ids"}},"type":"object","required":["name","characteristic_ids"],"title":"SpecificationUpdate"},"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"}},"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}}}}