offering-openapi.json

{"openapi":"3.1.0","info":{"title":"Offering Service","description":"Service for managing product offerings and their lifecycle","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/offerings":{"post":{"summary":"Create Offering","operationId":"create_offering_api_v1_offerings_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/OfferingCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"summary":"List Offerings","operationId":"list_offerings_api_v1_offerings_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/OfferingRead"},"title":"Response List Offerings Api V1 Offerings Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/offerings/{offering_id}":{"get":{"summary":"Get Offering","operationId":"get_offering_api_v1_offerings__offering_id__get","parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"summary":"Update Offering","operationId":"update_offering_api_v1_offerings__offering_id__put","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering 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/OfferingUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"summary":"Delete Offering","operationId":"delete_offering_api_v1_offerings__offering_id__delete","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering 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/offerings/{offering_id}/publish":{"post":{"summary":"Publish Offering","operationId":"publish_offering_api_v1_offerings__offering_id__publish_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering 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":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/offerings/{offering_id}/retire":{"post":{"summary":"Retire Offering","operationId":"retire_offering_api_v1_offerings__offering_id__retire_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering 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":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/offerings/{offering_id}/confirm":{"post":{"summary":"Confirm Offering","operationId":"confirm_offering_api_v1_offerings__offering_id__confirm_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering 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":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/offerings/{offering_id}/fail":{"post":{"summary":"Fail Offering","operationId":"fail_offering_api_v1_offerings__offering_id__fail_post","security":[{"HTTPBearer":[]}],"parameters":[{"name":"offering_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Offering 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":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingRead"}}}},"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"},"LifecycleStatus":{"type":"string","enum":["DRAFT","PUBLISHING","PUBLISHED","RETIRED"],"title":"LifecycleStatus"},"OfferingCreate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"specification_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Specification Ids"},"pricing_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pricing Ids"},"sales_channels":{"items":{"type":"string"},"type":"array","title":"Sales Channels"}},"type":"object","required":["name"],"title":"OfferingCreate"},"OfferingRead":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"specification_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Specification Ids"},"pricing_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pricing Ids"},"sales_channels":{"items":{"type":"string"},"type":"array","title":"Sales Channels"},"id":{"type":"string","format":"uuid","title":"Id"},"lifecycle_status":{"$ref":"#/components/schemas/LifecycleStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"published_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Published At"},"retired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Retired At"}},"type":"object","required":["name","id","lifecycle_status","created_at","updated_at"],"title":"OfferingRead"},"OfferingUpdate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"specification_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Specification Ids"},"pricing_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Pricing Ids"},"sales_channels":{"items":{"type":"string"},"type":"array","title":"Sales Channels"}},"type":"object","required":["name"],"title":"OfferingUpdate"},"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"}}}}