1 line
No EOL
12 KiB
JSON
1 line
No EOL
12 KiB
JSON
{"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__delete","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":{"202":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AcceptedResponse":{"properties":{"id":{"type":"integer","title":"Id"}},"type":"object","required":["id"],"title":"AcceptedResponse","description":"A generic payload to respond with where a request has been accepted but perhaps has not yet been processed.\nPairs well with HTTP status code 201."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"MirrorsOriginCreate":{"properties":{"description":{"type":"string","title":"Description","examples":["Main website","Images CDN"]},"host":{"type":"string","pattern":"[A-Za-z]\\Z","title":"Host","examples":["www.example.com"]},"first_party_adobe":{"anyOf":[{"$ref":"#/components/schemas/MirrorsRewriterConfigurationOriginFirstParty"},{"type":"null"}]},"first_party_tealium":{"anyOf":[{"$ref":"#/components/schemas/MirrorsRewriterConfigurationOriginFirstParty"},{"type":"null"}]},"geo_redirect_disable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Geo Redirect Disable","examples":[true]},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","examples":[{"Friendly-Client":"258f3a074f9c34d687a142b9ba4fd809"}]},"host_connect":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Connect","examples":["www.example.org"]},"host_header":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Header","examples":["www.example.org"]},"host_ssl":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Ssl","examples":["www.example.org"]},"rewrite_disable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rewrite Disable","examples":[true]}},"type":"object","required":["description","host"],"title":"MirrorsOriginCreate"},"MirrorsOriginDetail":{"properties":{"id":{"type":"integer","title":"Id"},"host":{"type":"string","title":"Host"},"default_mirror":{"type":"string","title":"Default Mirror"},"description":{"type":"string","title":"Description"},"deployment_status":{"$ref":"#/components/schemas/TofuInstanceStatus"},"deployment_status_changed_at":{"type":"string","format":"date-time","title":"Deployment Status Changed At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"first_party_adobe":{"anyOf":[{"$ref":"#/components/schemas/MirrorsRewriterConfigurationOriginFirstParty"},{"type":"null"}]},"first_party_tealium":{"anyOf":[{"$ref":"#/components/schemas/MirrorsRewriterConfigurationOriginFirstParty"},{"type":"null"}]},"geo_redirect_disable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Geo Redirect Disable","examples":[true]},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","examples":[{"Friendly-Client":"258f3a074f9c34d687a142b9ba4fd809"}]},"host_connect":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Connect","examples":["www.example.org"]},"host_header":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Header","examples":["www.example.org"]},"host_ssl":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Ssl","examples":["www.example.org"]},"rewrite_disable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rewrite Disable","examples":[true]}},"type":"object","required":["id","host","default_mirror","description","deployment_status","deployment_status_changed_at","created_at","updated_at"],"title":"MirrorsOriginDetail"},"MirrorsOriginSummary":{"properties":{"id":{"type":"integer","title":"Id"},"host":{"type":"string","title":"Host"},"default_mirror":{"type":"string","title":"Default Mirror"},"description":{"type":"string","title":"Description"},"deployment_status":{"$ref":"#/components/schemas/TofuInstanceStatus"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","host","default_mirror","description","deployment_status","created_at","updated_at"],"title":"MirrorsOriginSummary"},"MirrorsOriginUpdate":{"properties":{"description":{"type":"string","title":"Description","examples":["Main website","Images CDN"]},"first_party_adobe":{"anyOf":[{"$ref":"#/components/schemas/MirrorsRewriterConfigurationOriginFirstParty"},{"type":"null"}]},"first_party_tealium":{"anyOf":[{"$ref":"#/components/schemas/MirrorsRewriterConfigurationOriginFirstParty"},{"type":"null"}]},"geo_redirect_disable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Geo Redirect Disable","examples":[true]},"headers":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Headers","examples":[{"Friendly-Client":"258f3a074f9c34d687a142b9ba4fd809"}]},"host_connect":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Connect","examples":["www.example.org"]},"host_header":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Header","examples":["www.example.org"]},"host_ssl":{"anyOf":[{"type":"string","pattern":"[A-Za-z]\\Z"},{"type":"null"}],"title":"Host Ssl","examples":["www.example.org"]},"rewrite_disable":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Rewrite Disable","examples":[true]}},"type":"object","required":["description"],"title":"MirrorsOriginUpdate"},"MirrorsRewriterConfigurationOriginFirstParty":{"properties":{"subdomain":{"type":"string","title":"Subdomain"},"account":{"type":"string","title":"Account"}},"type":"object","required":["subdomain","account"],"title":"MirrorsRewriterConfigurationOriginFirstParty"},"Page_MirrorsOriginSummary_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/MirrorsOriginSummary"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","page","size"],"title":"Page[MirrorsOriginSummary]"},"TofuInstanceStatus":{"type":"string","enum":["ACTIVE","DEPLOYING","DESTROYED","DESTROYING","DRIFTED","FAILED","FAILED_DESTROY","PENDING","PENDING_DESTROY","PENDING_DRIFT_CHECK"],"title":"TofuInstanceStatus"},"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":{"OpenIdConnect":{"type":"openIdConnect","openIdConnectUrl":"https://id.guardianproject.info/realms/gp/.well-known/openid-configuration"}}}} |