openapi.json

{"openapi":"3.0.2","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/healthcheck":{"get":{"summary":"Healthcheck","operationId":"healthcheck_healthcheck_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/v1/availability":{"post":{"tags":["articles"],"summary":"Check availability of a list of skus","description":"Check availabilty of a list of skus","operationId":"availability_v1_availability_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilitySkuRequest"}}},"required":true},"responses":{"200":{"description":"List of skus with the result of their availability","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2CodeBearer":[]}]}},"/v1/reservations":{"post":{"tags":["articles"],"summary":"Reserve a list of skus","description":"Reserve a list of skus, in order to **prevent double sales** on other shops","operationId":"reserve_v1_reservations_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveSkuRequest"}}},"required":true},"responses":{"200":{"description":"List of skus with the result of reserving them","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2CodeBearer":[]}]}},"/v1/full_stock":{"get":{"tags":["articles"],"summary":"Retrieve all available articles","description":"Retrieve all sellable articles for a full sync.","operationId":"full_stock_v1_full_stock_get","parameters":[{"required":false,"schema":{"title":"Resume from row","minimum":0.0,"type":"integer","default":0},"name":"offset","in":"query"},{"required":false,"schema":{"title":"Number of results per page","minimum":1.0,"type":"integer","default":10},"name":"limit","in":"query"},{"required":false,"schema":{"title":"Which fields of the article to display","uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/ArticleFields"}},"name":"article_fields","in":"query"}],"responses":{"200":{"description":"List of articles","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2CodeBearer":[]}]}},"/v1/confirm_reservation":{"post":{"tags":["articles"],"summary":"Confirm reservation for a list of skus","description":"Confirm reservation for a list of previously reserved skus","operationId":"confirm_v1_confirm_reservation_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmReservationRequest"}}},"required":true},"responses":{"200":{"description":"List of skus with and confirmation result","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2CodeBearer":[]}]}},"/v1/release_reservation":{"post":{"tags":["articles"],"summary":"Release reservation for a list of skus","description":"Release reservation for a list of previously reserved skus","operationId":"release_v1_release_reservation_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleaseReservationRequest"}}},"required":true},"responses":{"200":{"description":"List of skus with and result","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"OAuth2CodeBearer":[]}]}}},"components":{"schemas":{"ArticleFields":{"title":"ArticleFields","enum":["sku","article_uuid","product_uuid","attributes","reservation_time","is_paid","is_stocked","reserved_by","reservation_confirmed","reservation_confirmed_time","condition"],"description":"An enumeration."},"AvailabilitySkuRequest":{"title":"AvailabilitySkuRequest","required":["skus"],"type":"object","properties":{"skus":{"title":"Skus","type":"array","items":{"type":"string"}}}},"ConfirmReservationRequest":{"title":"ConfirmReservationRequest","required":["reservation_id","skus"],"type":"object","properties":{"reservation_id":{"title":"Reservation Id","type":"string"},"skus":{"title":"Skus","type":"array","items":{"type":"string"}}}},"HTTPValidationError":{"title":"HTTPValidationError","type":"object","properties":{"detail":{"title":"Detail","type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ReleaseReservationRequest":{"title":"ReleaseReservationRequest","required":["reservation_id","skus"],"type":"object","properties":{"reservation_id":{"title":"Reservation Id","type":"string"},"skus":{"title":"Skus","type":"array","items":{"type":"string"}}}},"ReserveSkuRequest":{"title":"ReserveSkuRequest","required":["reservation_id","skus"],"type":"object","properties":{"reservation_id":{"title":"Reservation Id","type":"string"},"skus":{"title":"Skus","type":"array","items":{"type":"string"}}}},"ValidationError":{"title":"ValidationError","required":["loc","msg","type"],"type":"object","properties":{"loc":{"title":"Location","type":"array","items":{"type":"string"}},"msg":{"title":"Message","type":"string"},"type":{"title":"Error Type","type":"string"}}}},"securitySchemes":{"OAuth2CodeBearer":{"type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"token"}}}}}}