· 7 years ago · Nov 03, 2018, 12:38 PM
1{"info": {"version": "1.0", "title": "API"}, "paths": {"/": {"get": {"tags": ["default"], "responses": {"200": {"description": "Success"}}, "operationId": "get_ping"}}, "/api/swagger.json": {"get": {"operationId": "get_swagger", "summary": "swagger", "responses": {"200": {"description": "Success"}}, "tags": ["default"], "description": "json"}}, "/api/v1/projects/": {"post": {"tags": ["Projects"], "operationId": "post_projects", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Project"}}}, "parameters": [{"required": true, "in": "body", "name": "payload", "schema": {"$ref": "#/definitions/AddNotebook"}}, {"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Create new project"}, "get": {"tags": ["Projects"], "operationId": "get_projects", "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Project"}, "type": "array"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns user's projects"}}, "/api/v1/projects/{project_name}": {"delete": {"operationId": "delete_project_name", "responses": {"200": {"description": "Success"}}, "tags": ["Projects"], "summary": "Delete project"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}], "get": {"tags": ["Projects"], "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Project"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "operationId": "get_project_name"}}, "/api/v1/projects/{project_name}/datasets/": {"post": {"tags": ["Dataset"], "operationId": "post_datasets", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "parameters": [{"required": true, "in": "body", "name": "payload", "schema": {"$ref": "#/definitions/DatasetRef"}}, {"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Create new dataset"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}], "get": {"tags": ["Dataset"], "operationId": "get_datasets", "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Dataset"}, "type": "array"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a project's datasets"}}, "/api/v1/projects/{project_name}/datasets/{dataset_name}": {"delete": {"operationId": "delete_dataset_name", "responses": {"200": {"description": "Success"}}, "tags": ["Dataset"], "summary": "Delete dataset"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "dataset_name", "in": "path"}], "get": {"tags": ["Dataset"], "operationId": "get_dataset_name", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a dataset"}}, "/api/v1/projects/{project_name}/datasets/{dataset_name}/s3": {"parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "dataset_name", "in": "path"}], "get": {"tags": ["Dataset"], "operationId": "get_dataset_s3", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/S3"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns the s3 data for a dataset"}}, "/api/v1/projects/{project_name}/models/": {"post": {"tags": ["Dataset"], "operationId": "post_models", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "parameters": [{"required": true, "in": "body", "name": "payload", "schema": {"$ref": "#/definitions/AddNotebook"}}, {"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Create new model"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}], "get": {"tags": ["Dataset"], "operationId": "get_models", "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Dataset"}, "type": "array"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a project's models"}}, "/api/v1/projects/{project_name}/models/{model_name}": {"delete": {"operationId": "delete_model_name", "responses": {"200": {"description": "Success"}}, "tags": ["Dataset"], "summary": "Delete model"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "model_name", "in": "path"}], "get": {"tags": ["Dataset"], "operationId": "get_model_name", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Dataset"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a model"}}, "/api/v1/projects/{project_name}/models/{model_name}/s3": {"parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "model_name", "in": "path"}], "get": {"tags": ["Dataset"], "operationId": "get_model_s3", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/S3"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns the s3 data for a model"}}, "/api/v1/projects/{project_name}/notebooks/": {"post": {"tags": ["Projects"], "operationId": "post_notebooks", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Notebook"}}}, "parameters": [{"required": true, "in": "body", "name": "payload", "schema": {"$ref": "#/definitions/AddNotebook"}}, {"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Create new dataset"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_notebooks", "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Notebook"}, "type": "array"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a project's notebooks"}}, "/api/v1/projects/{project_name}/notebooks/{notebook_name}": {"delete": {"operationId": "delete_notebook_name", "responses": {"200": {"description": "Success"}}, "tags": ["Projects"], "summary": "Delete notebook"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "notebook_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_notebook_name", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Notebook"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a notebook"}}, "/api/v1/projects/{project_name}/notebooks/{notebook_name}/s3": {"parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "notebook_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_notebook_s3", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/S3"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns the s3 data for a notebook"}}, "/api/v1/projects/{project_name}/servings/": {"post": {"tags": ["Projects"], "operationId": "post_servings", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Serving"}}}, "parameters": [{"required": true, "in": "body", "name": "payload", "schema": {"$ref": "#/definitions/AddNotebook"}}, {"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Create new serving"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_servings", "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Serving"}, "type": "array"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a project's servings"}}, "/api/v1/projects/{project_name}/servings/{servings_name}": {"delete": {"operationId": "delete_servings_name", "responses": {"200": {"description": "Success"}}, "tags": ["Projects"], "summary": "Delete servings"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "servings_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_servings_name", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Serving"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a servings"}}, "/api/v1/projects/{project_name}/trainings/": {"post": {"tags": ["Projects"], "operationId": "post_trainings", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Trainings"}}}, "parameters": [{"required": true, "in": "body", "name": "payload", "schema": {"$ref": "#/definitions/AddNotebook"}}, {"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Create new dataset"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_trainings", "responses": {"200": {"description": "Success", "schema": {"items": {"$ref": "#/definitions/Trainings"}, "type": "array"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a project's trainings"}}, "/api/v1/projects/{project_name}/trainings/{trainings_name}": {"delete": {"operationId": "delete_trainings_name", "responses": {"200": {"description": "Success"}}, "tags": ["Projects"], "summary": "Delete trainings"}, "parameters": [{"required": true, "type": "string", "name": "project_name", "in": "path"}, {"required": true, "type": "string", "name": "trainings_name", "in": "path"}], "get": {"tags": ["Projects"], "operationId": "get_trainings_name", "responses": {"200": {"description": "Success", "schema": {"$ref": "#/definitions/Trainings"}}}, "parameters": [{"description": "An optional fields mask", "format": "mask", "type": "string", "name": "X-Fields", "in": "header"}], "summary": "Returns a trainings"}}}, "responses": {"MaskError": {"description": "When any error occurs on mask"}, "IntegrityError": {}, "ParseError": {"description": "When a mask can't be parsed"}}, "tags": [{"name": "default", "description": "Default namespace"}, {"name": "Projects", "description": "Project related operations"}, {"name": "Dataset", "description": "Project related operations"}, {"name": "Projects", "description": "Notebook related operations"}, {"name": "Dataset", "description": "Model related operations"}, {"name": "Projects", "description": "Trainings related operations"}, {"name": "Projects", "description": "Serving related operations"}], "basePath": "/", "produces": ["application/json"], "securityDefinitions": {"TokenAuth": {"type": "basic"}}, "definitions": {"Serving": {"required": ["id", "name"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"pattern": "^[0-9a-zA-Z_\\-/]+$", "type": "string", "minLength": 3}}}, "Trainings": {"required": ["id", "image", "name"], "type": "object", "properties": {"image": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}}}, "S3": {"required": ["access_key", "endpoint", "secret_key"], "type": "object", "properties": {"access_key": {"type": "string"}, "secret_key": {"type": "string"}, "endpoint": {"type": "string"}}}, "Dataset": {"required": ["id", "name"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}}, "Project": {"required": ["id", "name"], "type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}}}, "AddNotebook": {"required": ["model", "name"], "type": "object", "properties": {"model": {"$ref": "#/definitions/DatasetRef"}, "name": {"pattern": "^[0-9a-zA-Z_\\-/]+$", "type": "string", "minLength": 3}}}, "Notebook": {"required": ["endpoint", "id", "name"], "type": "object", "properties": {"endpoint": {"type": "string"}, "id": {"type": "string"}, "name": {"type": "string"}}}, "DatasetRef": {"required": ["name"], "type": "object", "properties": {"name": {"pattern": "^[0-9a-zA-Z_\\-/]+$", "type": "string", "minLength": 3}}}}, "swagger": "2.0", "consumes": ["application/json"]}