documentation.json

{
  "swagger": "2.0",
  "info": {
    "description": "This is the KML API documentation",
    "version": "1.0.0",
    "title": "Kml Server Uploader",
    "license": {
      "name": "MIT",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "host": "localhost:8080",
  "basePath": "/kml",
  "tags": [
    {
      "name": "Builder",
      "description": "All building kml calls"
    },
    {
      "name": "Manage"
    },
    {
      "name": "View Sync"
    },
    {
      "name": "Fly To"
    },
    {
      "name": "System"
    }
  ],
  "schemes": [
    "http"
  ],
  "paths": {
    "/builder/addplacemark": {
      "post": {
        "tags": [
          "Builder"
        ],
        "summary": "Add a new placemark",
        "description": "Add a placemark into the current kml",
        "operationId": "addPlacemark",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "The placemark was created",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Placemark"
            }
          }
        ],
        "responses": {
          "405": {
            "description": "Invalid input"
          }
        }
      }
    },
    "/builder/addphoto": {
      "post": {
        "tags": [
          "Builder"
        ],
        "summary": "Add image to the kml",
        "description": "Multiple status values can be provided with comma separated strings",
        "operationId": "findPetsByStatus",
        "consumes": [
          "multipart/form-data"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "Add a image to the current kml. Needs to set the id, the name, and the four courners. finally set the image file",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Photo"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          },
          "400": {
            "description": "Invalid status value"
          }
        }
      }
    },
    "/builder/concatenate": {
      "get": {
        "description": "Add a custom kml to the current displayed kml.",
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "The kml file",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Kml"
            }
          }
        ],
        "tags": [
          "Builder"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/builder/Orbit": {
      "post": {
        "tags": [
          "Builder"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        },
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "build a orbit, seting the longitude, latitude and range of the obrit. The name field will be the name of the tour, for later init it",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Orbit"
            }
          }
        ]
      }
    },
    "/builder/deleteTag/{tag}/{id}": {
      "delete": {
        "tags": [
          "Builder"
        ],
        "parameters": [
          {
            "name": "tag",
            "in": "path",
            "description": "The tag name that you want to delete",
            "required": true,
            "type": "string",
            "format": "string"
          },
          {
            "name": "id",
            "in": "path",
            "description": "The id of the tag to delete",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/new": {
      "post": {
        "summary": "Start a new KML",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "description": "The name for the new kml",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "tags": [
          "Manage"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/current": {
      "get": {
        "summary": "Return the id, name and path of the current kml",
        "tags": [
          "Manage"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/list": {
      "get": {
        "summary": "Get the kml list, and their id's from the server",
        "tags": [
          "Manage"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manae/clean": {
      "get": {
        "summary": "Clean the current visualitzation, and starts a new empty kml",
        "tags": [
          "Manage"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/{id}": {
      "get": {
        "summary": "Change the current kml to the designed by the id variable",
        "tags": [
          "Manage"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "id of the kml that you want to see",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      },
      "delete": {
        "summary": "Delete a Kml",
        "tags": [
          "Manage"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "id of the kml that you want to delete",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/balloon/{id}/{newState}": {
      "get": {
        "tags": [
          "Manage"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "The id of the placemark that contains the balloon that will be edited",
            "required": true,
            "type": "string",
            "format": "string"
          },
          {
            "name": "newState",
            "in": "path",
            "description": "set the new state of the balloon: 1 open, 0 close",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/initTour/{name}": {
      "get": {
        "tags": [
          "Manage"
        ],
        "parameters": [
          {
            "name": "name",
            "in": "path",
            "description": "The name of the tour to init",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/manage/upload": {
      "post": {
        "summary": "Upload a new kml to the system",
        "tags": [
          "Manage"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "description": "build a orbit, seting the longitude, latitude and range of the obrit. The name field will be the name of the tour, for later init it",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Kml"
            }
          }
        ],
        "description": "send the kml file to the server",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/system/{exec}": {
      "get": {
        "tags": [
          "System"
        ],
        "parameters": [
          {
            "name": "exec",
            "in": "path",
            "description": "The bash command to execute",
            "required": true,
            "type": "string",
            "format": "string"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          },
          "400": {
            "description": "Invalid status value"
          }
        }
      }
    },
    "/viewsync/master": {
      "get": {
        "tags": [
          "View Sync"
        ],
        "summary": "get the current master kml",
        "description": "returns the current master kml to be displayed in the liquid galaxy",
        "produces": [
          "application/vnd.google-earth.kml+xml"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/viewsync/slave": {
      "get": {
        "tags": [
          "View Sync"
        ],
        "summary": "get the current slave kml",
        "description": "returns the current slave kml to be displayed in the liquid galaxy",
        "produces": [
          "application/vnd.google-earth.kml+xml"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          }
        }
      }
    },
    "/flyto/{longitude}/{latitude}/{range}": {
      "post": {
        "tags": [
          "Fly To"
        ],
        "summary": "fly to a position",
        "description": "Moves the liquid galaxy into the asked position",
        "operationId": "flyto",
        "parameters": [
          {
            "name": "longitude",
            "in": "path",
            "description": "the longitude of the camera",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "latitude",
            "in": "path",
            "description": "the latitude of the camera",
            "required": true,
            "type": "integer",
            "format": "int64"
          },
          {
            "name": "range",
            "in": "path",
            "description": "The range of the camera",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "successful operation"
          },
          "400": {
            "description": "Invalid status value"
          }
        }
      }
    }
  },
  "definitions": {
    "Placemark": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "longitude": {
          "type": "integer",
          "format": "int32"
        },
        "latitude": {
          "type": "integer",
          "format": "int32"
        },
        "range": {
          "type": "integer",
          "format": "int32"
        },
        "altitudeMode": {
          "type": "string",
          "default": "relativeToGround",
          "enum": [
            "relativeToGround",
            "relativeToSea"
          ]
        },
        "description": {
          "type": "string",
          "description": "The bubble text"
        },
        "icon": {
          "type": "string",
          "description": "the path to the icon"
        },
        "scale": {
          "type": "integer",
          "description": "the scale of the icon"
        }
      }
    },
    "Photo": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "fCorner": {
          "type": "string",
          "description": "The down-left, corner. The data need to be in [lon,lat,rang] format"
        },
        "sCorner": {
          "type": "string",
          "description": "The down-right, corner. The data need to be in [lon,lat,rang] format"
        },
        "tCorner": {
          "type": "string",
          "description": "The top-right, corner. The data need to be in [lon,lat,rang] format"
        },
        "ftCorner": {
          "type": "string",
          "description": "The top-left, corner. The data need to be in [lon,lat,rang] format"
        },
        "photo": {
          "type": "object",
          "format": "png, jpg"
        }
      }
    },
    "Kml": {
      "type": "object",
      "properties": {
        "kml": {
          "type": "object",
          "format": "kml"
        }
      }
    },
    "Orbit": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "longitude": {
          "type": "string"
        },
        "latitude": {
          "type": "string"
        },
        "range": {
          "type": "string"
        }
      }
    }
  }
}