-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed 01b6383 with MkDocs version: 1.6.1
- Loading branch information
0 parents
commit 5c92d87
Showing
79 changed files
with
15,190 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
<!DOCTYPE html><html> | ||
<head> | ||
<title>Blackfish API</title> | ||
<link rel='icon' type='image/png' href='https://cdn.jsdelivr.net/gh/litestar-org/branding@main/assets/Branding%20-%20PNG%20-%20Transparent/Badge%20-%20Blue%20and%20Yellow.png'> | ||
<meta charset="utf-8"/> | ||
<meta name="viewport" content="width=device-width, initial-scale=1"> | ||
<link href="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui.css" rel="stylesheet"> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui-bundle.js" crossorigin></script> | ||
<script src="https://cdn.jsdelivr.net/npm/[email protected]/swagger-ui-standalone-preset.js" crossorigin></script> | ||
<style>body { margin: 0; padding: 0 }</style> | ||
</head> | ||
|
||
<body> | ||
<div id='swagger-container'/> | ||
<script type='text/javascript'> | ||
const ui = SwaggerUIBundle({ | ||
spec: {"info":{"title":"Blackfish API","version":"0.0.1"},"openapi":"3.1.0","servers":[{"url":"/"}],"paths":{"/":{"get":{"summary":"Index","operationId":"Index","responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"deprecated":false}},"/services":{"get":{"summary":"FetchServices","operationId":"ServicesFetchServices","parameters":[{"name":"image","in":"query","schema":{"oneOf":[{"type":"null"},{"type":"string"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"status","in":"query","schema":{"oneOf":[{"type":"null"},{"type":"string"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"host","in":"query","schema":{"oneOf":[{"type":"null"},{"type":"string"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"backend","in":"query","schema":{"oneOf":[{"type":"null"},{"type":"string"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FetchServicesServiceResponseBody"},"type":"array"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"post":{"summary":"RunService","operationId":"ServicesRunService","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunServiceServiceRequestRequestBody"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunServiceServiceResponseBody"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/services/{service_id}/stop":{"put":{"summary":"StopService","operationId":"ServicesServiceIdStopStopService","parameters":[{"name":"service_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopServiceRequest"}}},"required":true},"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StopServiceServiceResponseBody"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/services/{service_id}":{"get":{"summary":"RefreshService","operationId":"ServicesServiceIdRefreshService","parameters":[{"name":"service_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshServiceServiceResponseBody"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"delete":{"summary":"DeleteService","operationId":"ServicesServiceIdDeleteService","parameters":[{"name":"service_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/models":{"get":{"summary":"GetModels","operationId":"ModelsGetModels","parameters":[{"name":"profile","in":"query","schema":{"oneOf":[{"type":"null"},{"type":"string"}]},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false},{"name":"refresh","in":"query","schema":{"oneOf":[{"type":"null"},{"type":"boolean","default":false}],"default":false},"required":false,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/GetModelsModelResponseBody"},"type":"array"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"post":{"summary":"CreateModel","operationId":"ModelsCreateModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModelModelRequestBody"}}},"required":true},"responses":{"201":{"description":"Document created, URL follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModelModelResponseBody"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}},"/models/{model_id}":{"get":{"summary":"GetModel","operationId":"ModelsModelIdGetModel","parameters":[{"name":"model_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"200":{"description":"Request fulfilled, document follows","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModelModelResponseBody"}}}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false},"delete":{"summary":"DeleteModel","operationId":"ModelsModelIdDeleteModel","parameters":[{"name":"model_id","in":"path","schema":{"type":"string"},"required":true,"deprecated":false,"allowEmptyValue":false,"allowReserved":false}],"responses":{"204":{"description":"Request fulfilled, nothing follows","headers":{}},"400":{"description":"Bad request syntax or unsupported method","content":{"application/json":{"schema":{"properties":{"status_code":{"type":"integer"},"detail":{"type":"string"},"extra":{"additionalProperties":{},"type":["null","object","array"]}},"type":"object","required":["detail","status_code"],"description":"Validation Exception","examples":[{"status_code":400,"detail":"Bad Request","extra":{}}]}}}}},"deprecated":false}}},"components":{"schemas":{"CreateModelModelRequestBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"repo":{"type":"string"},"profile":{"type":"string"},"revision":{"type":"string"}},"type":"object","required":["profile","repo","revision"],"title":"CreateModelModelRequestBody"},"CreateModelModelResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"repo":{"type":"string"},"profile":{"type":"string"},"revision":{"type":"string"}},"type":"object","required":["profile","repo","revision"],"title":"CreateModelModelResponseBody"},"FetchServicesServiceResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoints":{"oneOf":[{"type":"null"},{"type":"string"}]},"image":{"type":"string"},"model":{"type":"string"},"status":{"oneOf":[{"type":"null"},{"type":"string"}]},"user":{"oneOf":[{"type":"null"},{"type":"string"}]},"host":{"type":"string"},"port":{"oneOf":[{"type":"null"},{"type":"integer"}]},"job_type":{"type":"string"},"job_id":{"oneOf":[{"type":"null"},{"type":"string"}]}},"type":"object","required":["host","image","job_type","model","name"],"title":"FetchServicesServiceResponseBody"},"GetModelModelResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"repo":{"type":"string"},"profile":{"type":"string"},"revision":{"type":"string"}},"type":"object","required":["profile","repo","revision"],"title":"GetModelModelResponseBody"},"GetModelsModelResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"repo":{"type":"string"},"profile":{"type":"string"},"revision":{"type":"string"}},"type":"object","required":["profile","repo","revision"],"title":"GetModelsModelResponseBody"},"RefreshServiceServiceResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoints":{"oneOf":[{"type":"null"},{"type":"string"}]},"image":{"type":"string"},"model":{"type":"string"},"status":{"oneOf":[{"type":"null"},{"type":"string"}]},"user":{"oneOf":[{"type":"null"},{"type":"string"}]},"host":{"type":"string"},"port":{"oneOf":[{"type":"null"},{"type":"integer"}]},"job_type":{"type":"string"},"job_id":{"oneOf":[{"type":"null"},{"type":"string"}]}},"type":"object","required":["host","image","job_type","model","name"],"title":"RefreshServiceServiceResponseBody"},"RunServiceServiceRequestRequestBody":{"properties":{"name":{"type":"string"},"image":{"type":"string"},"model":{"type":"string"},"job_type":{"type":"string"},"container_options":{"additionalProperties":{},"type":"object"},"job_options":{"additionalProperties":{},"type":"object"},"user":{"oneOf":[{"type":"null"},{"type":"string"}]},"host":{"oneOf":[{"type":"null"},{"type":"string","default":"localhost"}],"default":"localhost"},"port":{"oneOf":[{"type":"null"},{"type":"string"}]}},"type":"object","required":["container_options","image","job_options","job_type","model","name"],"title":"RunServiceServiceRequestRequestBody"},"RunServiceServiceResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoints":{"oneOf":[{"type":"null"},{"type":"string"}]},"image":{"type":"string"},"model":{"type":"string"},"status":{"oneOf":[{"type":"null"},{"type":"string"}]},"user":{"oneOf":[{"type":"null"},{"type":"string"}]},"host":{"type":"string"},"port":{"oneOf":[{"type":"null"},{"type":"integer"}]},"job_type":{"type":"string"},"job_id":{"oneOf":[{"type":"null"},{"type":"string"}]}},"type":"object","required":["host","image","job_type","model","name"],"title":"RunServiceServiceResponseBody"},"StopServiceRequest":{"properties":{"delay":{"type":"integer","default":0},"timeout":{"type":"boolean","default":false},"failed":{"type":"boolean","default":false}},"type":"object","required":[],"title":"StopServiceRequest"},"StopServiceServiceResponseBody":{"properties":{"id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"endpoints":{"oneOf":[{"type":"null"},{"type":"string"}]},"image":{"type":"string"},"model":{"type":"string"},"status":{"oneOf":[{"type":"null"},{"type":"string"}]},"user":{"oneOf":[{"type":"null"},{"type":"string"}]},"host":{"type":"string"},"port":{"oneOf":[{"type":"null"},{"type":"integer"}]},"job_type":{"type":"string"},"job_id":{"oneOf":[{"type":"null"},{"type":"string"}]}},"type":"object","required":["host","image","job_type","model","name"],"title":"StopServiceServiceResponseBody"}}}}, | ||
dom_id: '#swagger-container', | ||
deepLinking: true, | ||
showExtensions: true, | ||
showCommonExtensions: true, | ||
presets: [ | ||
SwaggerUIBundle.presets.apis, | ||
SwaggerUIBundle.SwaggerUIStandalonePreset | ||
], | ||
}) | ||
ui.initOAuth({}) | ||
</script> | ||
</body> | ||
</html> |
Oops, something went wrong.