Skip to content

Instantly share code, notes, and snippets.

@leigh-johnson

leigh-johnson/schema

Created November 15, 2020 07:53
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save leigh-johnson/a9a4f1bea4e5d6919bf9464dac84ad60 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save leigh-johnson/a9a4f1bea4e5d6919bf9464dac84ad60 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
schema
{
"openapi": "3.0.3",
"info": {
"title": "",
"version": "0.0.0"
},
"paths": {
"/api/auth-token/": {
"post": {
"operationId": "auth_token_create",
"description": "",
"tags": [
"auth-token"
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/AuthTokenRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/AuthTokenRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthTokenRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthToken"
}
}
},
"description": ""
}
}
}
},
"/api/events/octoprint/": {
"get": {
"operationId": "events_octoprint_list",
"description": "",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"events"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedOctoPrintEventList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "events_octoprint_create",
"description": "",
"tags": [
"events"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OctoPrintEventRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OctoPrintEventRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/OctoPrintEventRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OctoPrintEvent"
}
}
},
"description": ""
}
}
}
},
"/api/events/predict/": {
"get": {
"operationId": "events_predict_list",
"description": "",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"events"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPredictEventList"
}
}
},
"description": ""
},
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPredictEventList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "events_predict_create",
"description": "",
"tags": [
"events"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PredictEventRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PredictEventRequest"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredictEventRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredictEvent"
}
}
},
"description": ""
}
}
}
},
"/api/gcode_files/": {
"get": {
"operationId": "gcode_files_list",
"description": "",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"gcode_files"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedGcodeFileList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "gcode_files_create",
"description": "",
"tags": [
"gcode_files"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GcodeFileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/GcodeFileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
}
}
}
},
"/api/gcode_files/{id}/": {
"get": {
"operationId": "gcode_files_retrieve",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this gcode file.",
"required": true
}
],
"tags": [
"gcode_files"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "gcode_files_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this gcode file.",
"required": true
}
],
"tags": [
"gcode_files"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GcodeFileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/GcodeFileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "gcode_files_partial_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this gcode file.",
"required": true
}
],
"tags": [
"gcode_files"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedGcodeFileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedGcodeFileRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
}
}
}
},
"/api/gcode_files/update_or_create/": {
"post": {
"operationId": "gcode_files_update_or_create",
"description": "",
"tags": [
"gcode_files"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/GcodeFileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/GcodeFileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
},
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GcodeFile"
}
}
},
"description": ""
}
}
}
},
"/api/print_jobs/": {
"get": {
"operationId": "print_jobs_list",
"description": "",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"print_jobs"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPrintJobList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "print_jobs_create",
"description": "",
"tags": [
"print_jobs"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintJobRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PrintJobRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PrintJobRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintJob"
}
}
},
"description": ""
}
}
}
},
"/api/print_jobs/{id}/": {
"get": {
"operationId": "print_jobs_retrieve",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this print job.",
"required": true
}
],
"tags": [
"print_jobs"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintJob"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "print_jobs_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this print job.",
"required": true
}
],
"tags": [
"print_jobs"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintJobRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PrintJobRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PrintJobRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintJob"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "print_jobs_partial_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this print job.",
"required": true
}
],
"tags": [
"print_jobs"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPrintJobRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedPrintJobRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedPrintJobRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrintJob"
}
}
},
"description": ""
}
}
}
},
"/api/printer_profiles/": {
"get": {
"operationId": "printer_profiles_list",
"description": "",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "name",
"required": false,
"in": "query",
"description": "name",
"schema": {
"type": "string"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
},
{
"name": "user",
"required": false,
"in": "query",
"description": "user",
"schema": {
"type": "string"
}
}
],
"tags": [
"printer_profiles"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedPrinterProfileList"
}
}
},
"description": ""
}
}
},
"post": {
"operationId": "printer_profiles_create",
"description": "",
"tags": [
"printer_profiles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
}
}
}
},
"/api/printer_profiles/{id}/": {
"get": {
"operationId": "printer_profiles_retrieve",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this printer profile.",
"required": true
}
],
"tags": [
"printer_profiles"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "printer_profiles_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this printer profile.",
"required": true
}
],
"tags": [
"printer_profiles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "printer_profiles_partial_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this printer profile.",
"required": true
}
],
"tags": [
"printer_profiles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedPrinterProfileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedPrinterProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedPrinterProfileRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
}
}
}
},
"/api/printer_profiles/update_or_create/": {
"post": {
"operationId": "printer_profiles_update_or_create",
"description": "",
"tags": [
"printer_profiles"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PrinterProfileRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
},
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
},
"description": ""
}
}
}
},
"/api/schema/": {
"get": {
"operationId": "schema_retrieve",
"description": "OpenApi3 schema for this API. Format can be selected via content negotiation.\n\n- YAML: application/vnd.oai.openapi\n- JSON: application/vnd.oai.openapi+json",
"parameters": [
{
"in": "query",
"name": "lang",
"schema": {
"type": "string",
"enum": [
"af",
"ar",
"ar-dz",
"ast",
"az",
"be",
"bg",
"bn",
"br",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"dsb",
"el",
"en",
"en-au",
"en-gb",
"eo",
"es",
"es-ar",
"es-co",
"es-mx",
"es-ni",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fr",
"fy",
"ga",
"gd",
"gl",
"he",
"hi",
"hr",
"hsb",
"hu",
"hy",
"ia",
"id",
"ig",
"io",
"is",
"it",
"ja",
"ka",
"kab",
"kk",
"km",
"kn",
"ko",
"ky",
"lb",
"lt",
"lv",
"mk",
"ml",
"mn",
"mr",
"my",
"nb",
"ne",
"nl",
"nn",
"os",
"pa",
"pl",
"pt",
"pt-br",
"ro",
"ru",
"sk",
"sl",
"sq",
"sr",
"sr-latn",
"sv",
"sw",
"ta",
"te",
"tg",
"th",
"tk",
"tr",
"tt",
"udm",
"uk",
"ur",
"uz",
"vi",
"zh-hans",
"zh-hant"
]
}
}
],
"tags": [
"schema"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
},
{}
],
"responses": {
"200": {
"content": {
"application/vnd.oai.openapi+json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
},
"application/json": {
"schema": {
"type": "object",
"additionalProperties": {}
}
}
},
"description": ""
}
}
}
},
"/api/users/": {
"get": {
"operationId": "users_list",
"description": "",
"parameters": [
{
"name": "limit",
"required": false,
"in": "query",
"description": "Number of results to return per page.",
"schema": {
"type": "integer"
}
},
{
"name": "offset",
"required": false,
"in": "query",
"description": "The initial index from which to return the results.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedUserList"
}
}
},
"description": ""
}
}
}
},
"/api/users/{id}/": {
"get": {
"operationId": "users_retrieve",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"put": {
"operationId": "users_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/UserRequest"
}
}
},
"required": true
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
},
"patch": {
"operationId": "users_partial_update",
"description": "",
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "integer"
},
"description": "A unique integer value identifying this user.",
"required": true
}
],
"tags": [
"users"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedUserRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/PatchedUserRequest"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/PatchedUserRequest"
}
}
}
},
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
}
},
"/api/users/me/": {
"get": {
"operationId": "users_me_retrieve",
"description": "",
"tags": [
"users"
],
"security": [
{
"cookieAuth": []
},
{
"tokenAuth": []
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": ""
}
}
}
}
},
"components": {
"schemas": {
"AuthToken": {
"type": "object",
"properties": {
"token": {
"type": "string",
"readOnly": true
}
}
},
"AuthTokenRequest": {
"type": "object",
"properties": {
"username": {
"type": "string",
"writeOnly": true
},
"password": {
"type": "string",
"writeOnly": true
}
},
"required": [
"password",
"username"
]
},
"GcodeFile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"name": {
"type": "string",
"maxLength": 255
},
"file": {
"type": "string",
"format": "uri"
},
"file_hash": {
"type": "string",
"maxLength": 255
},
"user": {
"type": "integer",
"readOnly": true
}
},
"required": [
"file",
"file_hash",
"name"
]
},
"GcodeFileRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"file": {
"type": "string",
"format": "binary"
},
"file_hash": {
"type": "string",
"maxLength": 255
}
},
"required": [
"file",
"file_hash",
"name"
]
},
"LastStatusEnum": {
"enum": [
"STARTED",
"DONE",
"FAILED",
"CANCELLING",
"CANCELLED",
"RESUMED"
],
"type": "string"
},
"OctoPrintEvent": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"dt": {
"type": "string",
"format": "date-time"
},
"event_type": {
"type": "string",
"maxLength": 30
},
"event_data": {
"type": "object",
"additionalProperties": {}
},
"plugin_version": {
"type": "string",
"maxLength": 30
},
"octoprint_version": {
"type": "string",
"maxLength": 30
},
"user": {
"type": "integer",
"readOnly": true
}
},
"required": [
"dt",
"event_data",
"event_type",
"octoprint_version",
"plugin_version"
]
},
"OctoPrintEventRequest": {
"type": "object",
"properties": {
"dt": {
"type": "string",
"format": "date-time"
},
"event_type": {
"type": "string",
"maxLength": 30
},
"event_data": {
"type": "object",
"additionalProperties": {}
},
"plugin_version": {
"type": "string",
"maxLength": 30
},
"octoprint_version": {
"type": "string",
"maxLength": 30
}
},
"required": [
"dt",
"event_data",
"event_type",
"octoprint_version",
"plugin_version"
]
},
"PaginatedGcodeFileList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GcodeFile"
}
}
}
},
"PaginatedOctoPrintEventList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OctoPrintEvent"
}
}
}
},
"PaginatedPredictEventList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PredictEvent"
}
}
}
},
"PaginatedPrintJobList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrintJob"
}
}
}
},
"PaginatedPrinterProfileList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrinterProfile"
}
}
}
},
"PaginatedUserList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=400&limit=100"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?offset=200&limit=100"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
},
"PatchedGcodeFileRequest": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 255
},
"file": {
"type": "string",
"format": "binary"
},
"file_hash": {
"type": "string",
"maxLength": 255
}
}
},
"PatchedPrintJobRequest": {
"type": "object",
"properties": {
"dt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"maxLength": 255
},
"gcode_file_hash": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"last_status": {
"$ref": "#/components/schemas/LastStatusEnum"
},
"printer_profile": {
"type": "integer"
},
"gcode_file": {
"type": "integer",
"nullable": true
}
}
},
"PatchedPrinterProfileRequest": {
"type": "object",
"properties": {
"axes_e_inverted": {
"type": "boolean"
},
"axes_e_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_x_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_x_inverted": {
"type": "boolean"
},
"axes_y_inverted": {
"type": "boolean"
},
"axes_y_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_z_inverted": {
"type": "boolean"
},
"axes_z_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"extruder_count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"extruder_nozzle_diameter": {
"type": "number",
"format": "float"
},
"extruder_offsets": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"nullable": true
},
"extruder_shared_nozzle": {
"type": "boolean"
},
"heated_bed": {
"type": "boolean"
},
"heated_chamber": {
"type": "boolean"
},
"model": {
"type": "string",
"maxLength": 255
},
"name": {
"type": "string",
"maxLength": 255
},
"volume_custom_box": {
"type": "boolean"
},
"volume_depth": {
"type": "number",
"format": "float"
},
"volume_formfactor": {
"type": "string",
"maxLength": 255
},
"volume_height": {
"type": "number",
"format": "float"
},
"volume_origin": {
"type": "string",
"maxLength": 255
},
"volume_width": {
"type": "number",
"format": "float"
}
}
},
"PatchedUserRequest": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 254
}
}
},
"PredictEvent": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"dt": {
"type": "string",
"format": "date-time"
},
"original_image": {
"type": "string",
"format": "uri"
},
"annotated_image": {
"type": "string",
"format": "uri"
},
"event_data": {
"type": "object",
"additionalProperties": {},
"nullable": true
},
"plugin_version": {
"type": "string",
"maxLength": 30
},
"octoprint_version": {
"type": "string",
"maxLength": 30
},
"user": {
"type": "integer",
"readOnly": true
},
"print_job": {
"type": "integer",
"nullable": true
}
},
"required": [
"annotated_image",
"octoprint_version",
"original_image",
"plugin_version"
]
},
"PredictEventRequest": {
"type": "object",
"properties": {
"dt": {
"type": "string",
"format": "date-time"
},
"original_image": {
"type": "string",
"format": "binary"
},
"annotated_image": {
"type": "string",
"format": "binary"
},
"event_data": {
"type": "object",
"additionalProperties": {},
"nullable": true
},
"plugin_version": {
"type": "string",
"maxLength": 30
},
"octoprint_version": {
"type": "string",
"maxLength": 30
},
"print_job": {
"type": "integer",
"nullable": true
}
},
"required": [
"annotated_image",
"octoprint_version",
"original_image",
"plugin_version"
]
},
"PrintJob": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"dt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"maxLength": 255
},
"gcode_file_hash": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"last_status": {
"$ref": "#/components/schemas/LastStatusEnum"
},
"user": {
"type": "integer",
"readOnly": true
},
"printer_profile": {
"type": "integer"
},
"gcode_file": {
"type": "integer",
"nullable": true
}
},
"required": [
"dt",
"name",
"printer_profile"
]
},
"PrintJobRequest": {
"type": "object",
"properties": {
"dt": {
"type": "string",
"format": "date-time"
},
"name": {
"type": "string",
"maxLength": 255
},
"gcode_file_hash": {
"type": "string",
"nullable": true,
"maxLength": 255
},
"last_status": {
"$ref": "#/components/schemas/LastStatusEnum"
},
"printer_profile": {
"type": "integer"
},
"gcode_file": {
"type": "integer",
"nullable": true
}
},
"required": [
"dt",
"name",
"printer_profile"
]
},
"PrinterProfile": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"axes_e_inverted": {
"type": "boolean"
},
"axes_e_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_x_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_x_inverted": {
"type": "boolean"
},
"axes_y_inverted": {
"type": "boolean"
},
"axes_y_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_z_inverted": {
"type": "boolean"
},
"axes_z_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"extruder_count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"extruder_nozzle_diameter": {
"type": "number",
"format": "float"
},
"extruder_offsets": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"nullable": true
},
"extruder_shared_nozzle": {
"type": "boolean"
},
"heated_bed": {
"type": "boolean"
},
"heated_chamber": {
"type": "boolean"
},
"model": {
"type": "string",
"maxLength": 255
},
"name": {
"type": "string",
"maxLength": 255
},
"volume_custom_box": {
"type": "boolean"
},
"volume_depth": {
"type": "number",
"format": "float"
},
"volume_formfactor": {
"type": "string",
"maxLength": 255
},
"volume_height": {
"type": "number",
"format": "float"
},
"volume_origin": {
"type": "string",
"maxLength": 255
},
"volume_width": {
"type": "number",
"format": "float"
},
"user": {
"type": "integer",
"readOnly": true
}
},
"required": [
"axes_e_inverted",
"axes_e_speed",
"axes_x_inverted",
"axes_x_speed",
"axes_y_inverted",
"axes_y_speed",
"axes_z_inverted",
"axes_z_speed",
"extruder_count",
"extruder_nozzle_diameter",
"extruder_shared_nozzle",
"heated_bed",
"heated_chamber",
"model",
"name",
"volume_custom_box",
"volume_depth",
"volume_formfactor",
"volume_height",
"volume_origin",
"volume_width"
]
},
"PrinterProfileRequest": {
"type": "object",
"properties": {
"axes_e_inverted": {
"type": "boolean"
},
"axes_e_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_x_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_x_inverted": {
"type": "boolean"
},
"axes_y_inverted": {
"type": "boolean"
},
"axes_y_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"axes_z_inverted": {
"type": "boolean"
},
"axes_z_speed": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"extruder_count": {
"type": "integer",
"maximum": 2147483647,
"minimum": -2147483648
},
"extruder_nozzle_diameter": {
"type": "number",
"format": "float"
},
"extruder_offsets": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "number",
"format": "float"
}
},
"nullable": true
},
"extruder_shared_nozzle": {
"type": "boolean"
},
"heated_bed": {
"type": "boolean"
},
"heated_chamber": {
"type": "boolean"
},
"model": {
"type": "string",
"maxLength": 255
},
"name": {
"type": "string",
"maxLength": 255
},
"volume_custom_box": {
"type": "boolean"
},
"volume_depth": {
"type": "number",
"format": "float"
},
"volume_formfactor": {
"type": "string",
"maxLength": 255
},
"volume_height": {
"type": "number",
"format": "float"
},
"volume_origin": {
"type": "string",
"maxLength": 255
},
"volume_width": {
"type": "number",
"format": "float"
}
},
"required": [
"axes_e_inverted",
"axes_e_speed",
"axes_x_inverted",
"axes_x_speed",
"axes_y_inverted",
"axes_y_speed",
"axes_z_inverted",
"axes_z_speed",
"extruder_count",
"extruder_nozzle_diameter",
"extruder_shared_nozzle",
"heated_bed",
"heated_chamber",
"model",
"name",
"volume_custom_box",
"volume_depth",
"volume_formfactor",
"volume_height",
"volume_origin",
"volume_width"
]
},
"User": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 254
},
"url": {
"type": "string",
"format": "uri",
"readOnly": true
}
},
"required": [
"email"
]
},
"UserRequest": {
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 254
}
},
"required": [
"email"
]
}
},
"securitySchemes": {
"cookieAuth": {
"type": "apiKey",
"in": "cookie",
"name": "Session"
},
"tokenAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "Bearer"
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment