Build OpenAPI 0.6.0 (divided overwrite flag)

build-api-0.6.0.json

{
   "components":{
      "schemas":{
         "ImportResult":{
            "description":"ImportResult(sceneId: str, projectId: str)",
            "properties":{
               "projectId":{
                  "type":"string"
               },
               "sceneId":{
                  "type":"string"
               }
            },
            "required":[
               "sceneId",
               "projectId"
            ],
            "type":"object",
            "x-module-name":"arcor2_build_data"
         }
      }
   },
   "info":{
      "title":"ARCOR2 Build Service (0.15.0)",
      "version":"0.6.0"
   },
   "openapi":"3.0.2",
   "paths":{
      "/project/import":{
         "put":{
            "description":"Imports a project from execution package.",
            "parameters":[
               {
                  "in":"query",
                  "name":"overwriteScene",
                  "schema":{
                     "default":false,
                     "type":"boolean"
                  }
               },
               {
                  "in":"query",
                  "name":"overwriteProject",
                  "schema":{
                     "default":false,
                     "type":"boolean"
                  }
               },
               {
                  "in":"query",
                  "name":"overwriteObjectTypes",
                  "schema":{
                     "default":false,
                     "type":"boolean"
                  }
               },
               {
                  "in":"query",
                  "name":"overwriteProjectSources",
                  "schema":{
                     "default":false,
                     "type":"boolean"
                  }
               },
               {
                  "in":"query",
                  "name":"overwriteCollisionModels",
                  "schema":{
                     "default":false,
                     "type":"boolean"
                  }
               }
            ],
            "requestBody":{
               "content":{
                  "multipart/form-data":{
                     "schema":{
                        "properties":{
                           "executionPackage":{
                              "format":"binary",
                              "type":"string"
                           }
                        },
                        "required":[
                           "executionPackage"
                        ],
                        "type":"object"
                     }
                  }
               }
            },
            "responses":{
               "200":{
                  "content":{
                     "application/json":{
                        "schema":{
                           "$ref":"#/components/schemas/ImportResult"
                        }
                     }
                  },
                  "description":"Ok"
               },
               "400":{
                  "content":{
                     "application/json":{
                        "schema":{
                           "type":"string"
                        }
                     }
                  },
                  "description":"Some other error occurred."
               },
               "401":{
                  "content":{
                     "application/json":{
                        "schema":{
                           "type":"string"
                        }
                     }
                  },
                  "description":"Invalid execution package."
               },
               "402":{
                  "content":{
                     "application/json":{
                        "schema":{
                           "type":"string"
                        }
                     }
                  },
                  "description":"A difference between package/project service detected (overwrite needed)."
               },
               "404":{
                  "content":{
                     "application/json":{
                        "schema":{
                           "type":"string"
                        }
                     }
                  },
                  "description":"Something is missing."
               }
            }
         }
      },
      "/project/{project_id}/publish":{
         "get":{
            "description":"Get zip file with execution package. To be used by the Execution service.",
            "parameters":[
               {
                  "description":"unique ID",
                  "in":"path",
                  "name":"project_id",
                  "required":true,
                  "schema":{
                     "type":"string"
                  }
               },
               {
                  "description":"Package name",
                  "in":"query",
                  "name":"packageName",
                  "required":false,
                  "schema":{
                     "default":"N/A",
                     "type":"string"
                  }
               }
            ],
            "responses":{
               "200":{
                  "content":{
                     "application/zip":{
                        "schema":{
                           "example":"The archive of execution package (.zip)",
                           "format":"binary",
                           "type":"string"
                        }
                     }
                  },
                  "description":"Ok"
               },
               "404":{
                  "description":"Project ID or some of the required items was not found."
               },
               "501":{
                  "description":"Project invalid."
               }
            }
         }
      }
   }
}