lipu-pali/static/openapi.json

1 line
12 KiB
JSON
Raw Normal View History

2025-05-22 20:20:27 +01:00
{"openapi":"3.1.0","info":{"title":"Jasima API","description":"API for deploying and managing cloud resources","version":"0.0.0"},"paths":{"/api/v1/mirrors/origins":{"get":{"tags":["Web Mirrors"],"summary":"Get Origins","operationId":"get_origins_api_v1_mirrors_origins_get","security":[{"OpenIdConnect":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"},{"name":"organisation-id","in":"header","required":false,"schema":{"type":"integer","title":"Organisation ID","description":"The ID of your organisation. You can find this within the portal.","default":1},"description":"The ID of your organisation. You can find this within the portal."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_MirrorsOriginSummary_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Web Mirrors"],"summary":"Create Origin","operationId":"create_origin_api_v1_mirrors_origins_post","security":[{"OpenIdConnect":[]}],"parameters":[{"name":"organisation-id","in":"header","required":false,"schema":{"type":"integer","title":"Organisation ID","description":"The ID of your organisation. You can find this within the portal.","default":1},"description":"The ID of your organisation. You can find this within the portal."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MirrorsOriginCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/mirrors/origins/{origin_id}":{"get":{"tags":["Web Mirrors"],"summary":"Get Origin","operationId":"get_origin_api_v1_mirrors_origins__origin_id__get","security":[{"OpenIdConnect":[]}],"parameters":[{"name":"origin_id","in":"path","required":true,"schema":{"type":"integer","title":"Origin Id"}},{"name":"organisation-id","in":"header","required":false,"schema":{"type":"integer","title":"Organisation ID","description":"The ID of your organisation. You can find this within the portal.","default":1},"description":"The ID of your organisation. You can find this within the portal."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MirrorsOriginDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Web Mirrors"],"summary":"Update Origin","operationId":"update_origin_api_v1_mirrors_origins__origin_id__put","security":[{"OpenIdConnect":[]}],"parameters":[{"name":"origin_id","in":"path","required":true,"schema":{"type":"integer","title":"Origin Id"}},{"name":"organisation-id","in":"header","required":false,"schema":{"type":"integer","title":"Organisation ID","description":"The ID of your organisation. You can find this within the portal.","default":1},"description":"The ID of your organisation. You can find this within the portal."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MirrorsOriginUpdate"}}}},"responses":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Web Mirrors"],"summary":"Delete Origin","operationId":"delete_origin_api_v1_mirrors_origins__origin_id__de