swagger.json

{
  "swagger": "2.0",
  "info": {
    "version": "1.0",
    "title": "Optimum Voyage App",
    "description": "API documentation for the Optimum Voyage app.",
    "contact": {}
  },
  "host": "",
  "basePath": "/api",
  "securityDefinitions": {
    "Authorization": {
      "type": "apiKey",
      "description": "",
      "name": "Authorization",
      "in": "header"
    }
  },
  "schemes": ["http"],
  "consumes": ["application/json"],
  "produces": ["application/json"],
  "paths": {
    "/users": {
      "post": {
        "description": "This endpoint allows `admin` users to create a new user with the `operator` role within the same organization as the `admin`. If a `superuser` uses this endpoint to create an `operator` user, it can be created in any organization.\n\nAuthentication: `superuser` & `admin`",
        "summary": "Create User",
        "tags": ["User"],
        "operationId": "UsersPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateUserRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Get all users.\n\nAuthentication: `superuser` only.",
        "summary": "GET Users",
        "tags": ["User"],
        "operationId": "UsersGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "patch": {
        "description": "Edit the currently signed in user.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Edit User",
        "tags": ["User"],
        "operationId": "UsersPatch",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/EditUserRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/users/{id}": {
      "get": {
        "description": "Get a single user by ID.\n\nAuthentication: `superuser`, `admin`, `operator`",
        "summary": "GET User by ID",
        "tags": ["User"],
        "operationId": "UsersByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/users/account": {
      "get": {
        "description": "Get extended data about the currently signed in user, including:\n - `id`\n - `role_id`\n - `email`\n - `organization_id`\n - `password`\n - `name`\n - `status`\n - `created_at`\n - `updated_at`\n - `session_token`\n - `refreshing_token`\n - `role`\n\nAuthentication: `superuser`, `admin`, `operator`",
        "summary": "GET Account",
        "tags": ["User"],
        "operationId": "UsersAccountGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/organizations/{organization_id}/users": {
      "post": {
        "description": "Allows creating a user on a specific organization. Currently this is used by super users to create admin users and, thus, this request will only create admin users.\n\nAuthentication: `superuser` only.",
        "summary": "Create Admin User",
        "tags": ["User"],
        "operationId": "OrganizationsAdminByOrganizationIdPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "organization_id",
            "in": "path",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateAdminUserRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Returns all admin users for a given organization.\n\nAuthentication: `superuser` only.",
        "summary": "Get admin users by organization",
        "tags": ["User"],
        "operationId": "OrganizationsUsersByOrganizationIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "organization_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/auth/login": {
      "post": {
        "description": "Pass an email and a password for a valid user and get a request token back.\n\nThe request token must be used on the header of all requests to protected endpoints with the key \"authorization\".\n\nAuthentication: `none`",
        "summary": "Login",
        "tags": ["Auth"],
        "operationId": "AuthLoginPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/LoginRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        },
        "security": []
      }
    },
    "/ports": {
      "post": {
        "description": "Authentication: `superuser` only.",
        "summary": "Create Port",
        "tags": ["Port"],
        "operationId": "PortsPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreatePortRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/ports/{id}": {
      "get": {
        "description": "Authentication: `superuser`, `admin` & `operator`.",
        "summary": "Get Port by ID",
        "tags": ["Port"],
        "operationId": "PortsByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/organizations": {
      "post": {
        "description": "Creates an organization. Pass in the name of the organization and a logo for white-labelling the platform.\n\nAuthentication: `superuser` only.",
        "summary": "Create organization",
        "tags": ["Organization"],
        "operationId": "OrganizationsPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateorganizationRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Get all organizations.\n\nAuthentication: `superuser` only.",
        "summary": "Get organizations",
        "tags": ["Organization"],
        "operationId": "OrganizationsGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/organizations/{id}": {
      "get": {
        "description": "Get a given organization by ID.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get organization by ID",
        "tags": ["Organization"],
        "operationId": "OrganizationsByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/organizations/3": {
      "patch": {
        "description": "TODO: Add Description",
        "summary": "Update Organization",
        "tags": ["Organization"],
        "operationId": "Organizations3Patch",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/UpdateOrganizationRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessel-reports": {
      "post": {
        "description": "Authentication: `superuser` only.",
        "summary": "Create Vessel Report",
        "tags": ["Vessel Report"],
        "operationId": "VesselReportsPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateVesselReportRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessel-reports/{id}": {
      "get": {
        "description": "Authentication: `superuser`, `admin` & `operator`.",
        "summary": "Get Vessel Report by ID",
        "tags": ["Vessel Report"],
        "operationId": "VesselReportsByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/voyages/{voyage_id}/vessel-reports?orderBy={orderBy}&limit={limit}&offset={offset}": {
      "get": {
        "description": "Returns all vessel-reports for a given voyage id.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get vessel-reports by voyage",
        "tags": ["Vessel Reports"],
        "operationId": "VesselReportsByVoyagesGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "voyage_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": "The Voyage ID."
          },
          {
            "name": "limit",
            "in": "path",
            "required": false,
            "type": "integer",
            "format": "int32",
            "description": "Maximum number of items to fetch."
          },
          {
            "name": "orderBy",
            "in": "path",
            "required": false,
            "type": "string",
            "description": "Order in ascending (oldest first) `asc` or descending (newest first) `desc` order based on ID."
          },
          {
            "name": "offset",
            "in": "path",
            "required": false,
            "type": "integer",
            "format": "int32",
            "description": "Offset the starting point of the query."
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessels": {
      "post": {
        "description": "Authentication: `superuser` only.",
        "summary": "Create Vessel",
        "tags": ["Vessel"],
        "operationId": "VesselsPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateVesselRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Returns all vessel.\n\nAuthentication: `superuser` only.",
        "summary": "Get Vessels",
        "tags": ["Vessel"],
        "operationId": "VesselsGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "patch": {
        "description": "Update data for a given vessel.\n\nAuthentication: `superuser` & `admin`.",
        "summary": "Update vessel",
        "tags": ["Vessel"],
        "operationId": "VesselsPatch",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/UpdatevesselRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessels/{id}": {
      "get": {
        "description": "Returns a single vessel by ID.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get vessel by ID",
        "tags": ["Vessel"],
        "operationId": "VesselsByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/organizations/{organization_id}/vessels": {
      "get": {
        "description": "Returns all vessels for a given organization (`admin` & `operators` should only have the option to display vessels for their own organization).\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get vessels by organization",
        "tags": ["Vessel"],
        "operationId": "OrganizationsVesselsByOrganizationIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "organization_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/voyages": {
      "post": {
        "description": "Creates a new \"voyage request\", sending data to Optimum Voyage. Until the first vessel report for the given vessel is received, the voyage status will be \"created\", after which it will be \"ongoing\" and once the vessel reaches its destination it will be \"completed\".\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Create Voyage",
        "tags": ["Voyage"],
        "operationId": "VoyagesPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateVoyageRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Get all voyages.\n\nAuthentication: `superuser` only.",
        "summary": "Get Voyages",
        "tags": ["Voyage"],
        "operationId": "VoyagesGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/voyages/{voyage_id}": {
      "get": {
        "description": "Get a single voyage by ID.\n\nAuthentication: `superuser` only.",
        "summary": "Get Voyage",
        "tags": ["Voyage"],
        "operationId": "VoyagesGetById",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "voyage_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": "Voyage ID"
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessels/{vessel_id}/voyages": {
      "get": {
        "description": "Get all voyages for a given vessel.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get Voyage by Vessel ID",
        "tags": ["Voyage"],
        "operationId": "VesselsVoyagesByVesselIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "vessel_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/organizations/{organization_id}/voyages?status={voyage_status}&orderBy={orderBy}&limit={limit}&offset={offset}": {
      "get": {
        "description": "Returns all voyages for a given organization.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get voyages by organization",
        "tags": ["Voyage"],
        "operationId": "OrganizationsVoyagesByOrganizationGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "organization_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          },
          {
            "name": "voyage_status",
            "in": "path",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "limit",
            "in": "path",
            "required": false,
            "type": "integer",
            "format": "int32",
            "description": "Maximum number of items to fetch."
          },
          {
            "name": "orderBy",
            "in": "path",
            "required": false,
            "type": "string",
            "description": "Order in ascending (oldest first) `asc` or descending (newest first) `desc` order based on ID."
          },
          {
            "name": "offset",
            "in": "path",
            "required": false,
            "type": "integer",
            "format": "int32",
            "description": "Offset the starting point of the query."
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/selected_routes": {
      "post": {
        "description": "Creates a route selection.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Create Selected Route",
        "tags": ["Selected Routes"],
        "operationId": "SelectedRoutesPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateSelectedRouteRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/selected-routes": {
      "get": {
        "description": "Returns all selected routes.\n\nAuthentication: `superuser` only.",
        "summary": "Get Selected Routes",
        "tags": ["Selected Routes"],
        "operationId": "SelectedRoutesGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/": {
      "get": {
        "description": "Returns only the latest selected route for a given voyage.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get current Selected Route by Voyage ID",
        "tags": ["Selected Routes"],
        "operationId": "UnnammedEndpointGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessel-reports/{vessel_report_id}/select-route/": {
      "post": {
        "description": "Selects suggested route by vessel report ID.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Selects suggested Route",
        "tags": ["Selected Routes"],
        "operationId": "SelectSuggestedRoutePost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "vessel_report_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateSelectSuggestedRouteRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Returns selected route by vessel report ID.\n\nAuthentication: `superuser`, `admin`, `operator` only.",
        "summary": "Get Selected Route by vessel report ID",
        "tags": ["Selected Routes"],
        "operationId": "SelectSuggestedRouteGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "vessel_report_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/suggested-routes": {
      "post": {
        "description": "Creates a suggested route.\n\nAuthentication: `superuser` only.",
        "summary": "Create Suggested Route",
        "tags": ["Suggested Routes"],
        "operationId": "SuggestedRoutesPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateSuggestedRouteRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "get": {
        "description": "Returns all suggested routes.\n\nAuthentication: `superuser` only.",
        "summary": "Get Suggested Routes",
        "tags": ["Suggested Routes"],
        "operationId": "SuggestedRoutesGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/suggested-routes/{id}": {
      "get": {
        "description": "Returns a single suggested route.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get Suggested Route by ID",
        "tags": ["Suggested Routes"],
        "operationId": "SuggestedRoutesByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/vessel-reports/{vessel_report_id}/suggested-routes": {
      "get": {
        "description": "Returns suggested routes with vessel report ID.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get Suggested Routes by vessel report ID",
        "tags": ["Suggested Routes"],
        "operationId": "SuggestedRoutesByVesselReportIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "vessel_report_id",
            "in": "path",
            "required": true,
            "type": "integer",
            "format": "int32",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/user-roles/{role}/users": {
      "get": {
        "description": "Returns users with the sepcific role.\n\nAuthentication: `superuser`, `admin`.",
        "summary": "Get Users by specific role",
        "tags": ["User by difference roles"],
        "operationId": "usersByRoleGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "role",
            "in": "path",
            "required": true,
            "type": "string",
            "format": "",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/favorite-vessels": {
      "post": {
        "description": "Creates a favorite vessel (association between user and vessel).\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Create Favorite Vessel",
        "tags": ["Favorite Vessels"],
        "operationId": "FavoriteVesselsPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreateFavoriteVesselRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      },
      "delete": {
        "description": "Deletes a favorite vessel association.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Delete Favorite Vessel",
        "tags": ["Favorite Vessels"],
        "operationId": "FavoriteVesselsDelete",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/DeleteFavoriteVesselRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/suggested-routes/{suggested_route_id}/waypoints": {
      "post": {
        "description": "Creates a waypoint. Note that you probably want to be using the endpoint for creating a route with waypoints or a port with a waypoint.\n\nAuthentication: `superuser` only.",
        "summary": "Create waypoint",
        "tags": ["Waypoints"],
        "operationId": "SuggestedRoutesWaypointsBySuggestedRouteIdPost",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "suggested_route_id",
            "in": "path",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "Content-Type",
            "in": "header",
            "required": true,
            "type": "string",
            "description": ""
          },
          {
            "name": "Body",
            "in": "body",
            "required": true,
            "description": "",
            "schema": {
              "$ref": "#/definitions/CreatewaypointRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    },
    "/waypoints/{id}": {
      "get": {
        "description": "Get a given waypoint.\n\nAuthentication: `superuser`, `admin` & `operator`.",
        "summary": "Get Waypoint by ID",
        "tags": ["Waypoints"],
        "operationId": "WaypointsByIdGet",
        "deprecated": false,
        "produces": ["application/json"],
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "type": "string",
            "description": ""
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "headers": {}
          }
        }
      }
    }
  },
  "definitions": {
    "CreateUserRequest": {
      "title": "CreateUserRequest",
      "example": {
        "name": "John Doe",
        "email": "test3@test3.com",
        "organization_id": 1
      },
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "organization_id": {
          "type": "integer",
          "format": "int32"
        }
      },
      "required": ["name", "email", "password", "organization_id"]
    },
    "EditUserRequest": {
      "title": "EditUserRequest",
      "example": {
        "email": "test3@test3.com",
        "password": "1234",
        "name": "Joey Dosik"
      },
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": ["email", "password", "name"]
    },
    "CreateAdminUserRequest": {
      "title": "CreateAdminUserRequest",
      "example": {
        "name": "John Doe",
        "email": "test3@test3.com",
        "password": "test3",
        "organization_id": 1
      },
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        },
        "organization_id": {
          "type": "integer",
          "format": "int32"
        }
      },
      "required": ["name", "email", "password", "organization_id"]
    },
    "LoginRequest": {
      "title": "LoginRequest",
      "example": {
        "email": "test@test.com",
        "password": "test"
      },
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "password": {
          "type": "string"
        }
      },
      "required": ["email", "password"]
    },
    "CreatePortRequest": {
      "title": "CreatePortRequest",
      "example": {
        "name": "Port sunshine",
        "longitude": 55.65646,
        "latitude": 12.53635,
        "depth": -12
      },
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "waypoint": {
          "type": "object",
          "items": {
            "$ref": "#/definitions/Waypoint"
          }
        }
      },
      "required": ["name", "waypoint"]
    },
    "Waypoint": {
      "title": "Waypoint",
      "example": {
        "longitude": 55.65646,
        "latitude": 12.53635
      },
      "type": "object",
      "properties": {
        "longitude": {
          "type": "number",
          "format": "double"
        },
        "latitude": {
          "type": "number",
          "format": "double"
        },
        "depth": {
          "type": "number",
          "format": "double"
        }
      },
      "required": ["lon", "lat", "depth"]
    },
    "CreateorganizationRequest": {
      "title": "CreateorganizationRequest",
      "example": {
        "name": "Teslasss",
        "logo": "/tesla-logo.png"
      },
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        }
      },
      "required": ["name", "logo"]
    },
    "UpdateOrganizationRequest": {
      "title": "UpdateOrganizationRequest",
      "example": {
        "name": "Teslaz",
        "logo": "fish"
      },
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "logo": {
          "type": "string"
        }
      },
      "required": ["name", "logo"]
    },
    "CreateVesselReportRequest": {
      "title": "CreateVesselReportRequest",
      "example": {
        "voyage_id": 3,
        "position_waypoint": 3,
        "current_speed": 10.1,
        "hfo_consumption": 30.2,
        "lsfo_consumption": 15.9,
        "latitude": "55.429013452407396",
        "longitude": "5.009765625"
      },
      "type": "object",
      "properties": {
        "vessel_id": {
          "type": "integer",
          "format": "int32"
        },
        "position_waypoint": {
          "type": "integer",
          "format": "int32"
        },
        "current_speed": {
          "type": "number",
          "format": "double"
        },
        "hfo_consumption": {
          "type": "number",
          "format": "double"
        },
        "lsfo_consumption": {
          "type": "number",
          "format": "double"
        }
      },
      "required": [
        "vessel_id",
        "position_waypoint",
        "current_speed",
        "hfo_consumption",
        "lsfo_consumption"
      ]
    },
    "CreateVesselRequest": {
      "title": "CreateVesselRequest",
      "example": {
        "organization_id": 1,
        "mmsi": "414243",
        "name": "MS Beautiful Day"
      },
      "type": "object",
      "properties": {
        "organization_id": {
          "type": "integer",
          "format": "int32"
        },
        "mmsi": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": ["organization_id", "mmsi", "name"]
    },
    "UpdatevesselRequest": {
      "title": "UpdatevesselRequest",
      "example": {
        "id": 1,
        "organization_id": 1,
        "mmsi": "414223",
        "name": "MS Million doll hairs"
      },
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "organization_id": {
          "type": "integer",
          "format": "int32"
        },
        "mmsi": {
          "type": "string"
        },
        "name": {
          "type": "string"
        }
      },
      "required": ["id", "organization_id", "mmsi", "name"]
    },
    "CreateVoyageRequest": {
      "title": "CreateVoyageRequest",
      "example": {
        "vessel_id": 1,
        "departure_time": "2019-09-10 21:20:09",
        "target_arrival_time": "2019-09-10 21:20:09",
        "forwarddraft": 8.596,
        "aftdraft": 8.785,
        "optimisation_type": "fixed_eta",
        "depart_from_port": 8,
        "arrive_at_port": 7,
        "hfocost": 89.63,
        "lsfocost": 87.52,
        "hirerate": 963.87,
        "status": "created"
      },
      "type": "object",
      "properties": {
        "vessel_id": {
          "type": "integer",
          "format": "int32"
        },
        "departure_time": {
          "type": "string"
        },
        "target_arrival_time": {
          "type": "string"
        },
        "forwarddraft": {
          "type": "number",
          "format": "double"
        },
        "aftdraft": {
          "type": "number",
          "format": "double"
        },
        "optimisation_type": {
          "type": "number",
          "format": "double"
        },
        "depart_from_port": {
          "type": "integer",
          "format": "int32"
        },
        "arrive_at_port": {
          "type": "integer",
          "format": "int32"
        },
        "hfocost": {
          "type": "number",
          "format": "double"
        },
        "lsfocost": {
          "type": "number",
          "format": "double"
        },
        "hirerate": {
          "type": "number",
          "format": "double"
        },
        "status": {
          "type": "string"
        }
      },
      "required": [
        "vessel_id",
        "departure_time",
        "target_arrival_time",
        "forwarddraft",
        "aftdraft",
        "optimisation_type",
        "depart_from_port",
        "arrive_at_port",
        "hfocost",
        "lsfocost",
        "hirerate",
        "status"
      ]
    },
    "CreateSelectedRouteRequest": {
      "title": "CreateSelectedRouteRequest",
      "example": {
        "vessel_report_id": 1,
        "suggested_route_id": 1
      },
      "type": "object",
      "properties": {
        "vessel_report_id": {
          "type": "integer",
          "format": "int32"
        },
        "suggested_route_id": {
          "type": "integer",
          "format": "int32"
        }
      },
      "required": ["vessel_report_id", "suggested_route_id"]
    },
    "CreateSelectSuggestedRouteRequest": {
      "title": "CreateSelectSuggestedRouteRequest",
      "example": {
        "suggested_route_id": 1
      },
      "type": "object",
      "properties": {
        "vessel_report_id": {
          "type": "integer",
          "format": "int32"
        },
        "suggested_route_id": {
          "type": "integer",
          "format": "int32"
        }
      },
      "required": ["suggested_route_id"]
    },
    "CreateSuggestedRouteRequest": {
      "title": "CreateSuggestedRouteRequest",
      "example": {
        "vessel_report_id": 1,
        "eta": "2012-03-19T07:32Z",
        "max_wave_height": 3.1,
        "hfo": 32.1,
        "lsfo": 11.2,
        "total_cost": 142042,
        "distance_over_ground": 1534.23,
        "distance_through_water": 1832.23,
        "avgspeed": 14.2,
        "waypoints": [
          {
            "longitude": 55.65646,
            "latitude": 12.53635,
            "speed": 12,
            "rpm": 800
          },
          {
            "longitude": 55.65646,
            "latitude": 12.53635,
            "speed": 12,
            "rpm": 800
          }
        ]
      },
      "type": "object",
      "properties": {
        "vessel_report_id": {
          "type": "integer",
          "format": "int32"
        },
        "eta": {
          "type": "string"
        },
        "max_wave_height": {
          "type": "number",
          "format": "double"
        },
        "hfo": {
          "type": "integer",
          "format": "int32"
        },
        "lsfo": {
          "type": "integer",
          "format": "int32"
        },
        "total_cost": {
          "type": "integer",
          "format": "int32"
        },
        "distance_over_ground": {
          "type": "integer",
          "format": "int32"
        },
        "distance_through_water": {
          "type": "integer",
          "format": "int32"
        },
        "avgspeed": {
          "type": "number",
          "format": "double"
        },
        "waypoints": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Waypoint"
          }
        }
      },
      "required": [
        "vessel_report_id",
        "eta",
        "max_wave_height",
        "hfo",
        "lsfo",
        "total_cost",
        "distance_over_ground",
        "distance_through_water",
        "avgspeed",
        "waypoints"
      ]
    },
    "CreateFavoriteVesselRequest": {
      "title": "CreateFavoriteVesselRequest",
      "example": {
        "user_id": 10,
        "vessel_id": 11
      },
      "type": "object",
      "properties": {
        "user_id": {
          "type": "integer",
          "format": "int32"
        },
        "vessel_id": {
          "type": "integer",
          "format": "int32"
        }
      },
      "required": ["user_id", "vessel_id"]
    },
    "DeleteFavoriteVesselRequest": {
      "title": "DeleteFavoriteVesselRequest",
      "example": {
        "user_id": 1,
        "vessel_id": 1
      },
      "type": "object",
      "properties": {
        "user_id": {
          "type": "integer",
          "format": "int32"
        },
        "vessel_id": {
          "type": "integer",
          "format": "int32"
        }
      },
      "required": ["user_id", "vessel_id"]
    },
    "CreatewaypointRequest": {
      "title": "CreatewaypointRequest",
      "example": {
        "suggested_route_id": 1,
        "lon": 55.678276,
        "lat": 12.47353,
        "sequence_id": 1,
        "port_id": null
      },
      "type": "object",
      "properties": {
        "suggested_route_id": {
          "type": "integer",
          "format": "int32"
        },
        "lon": {
          "type": "number",
          "format": "double"
        },
        "lat": {
          "type": "number",
          "format": "double"
        },
        "sequence_id": {
          "type": "integer",
          "format": "int32"
        },
        "port_id": {
          "type": "string"
        }
      },
      "required": ["suggested_route_id", "lon", "lat", "sequence_id", "port_id"]
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "tags": [
    {
      "name": "User"
    },
    {
      "name": "Auth"
    },
    {
      "name": "Port"
    },
    {
      "name": "Organization"
    },
    {
      "name": "Vessel Report"
    },
    {
      "name": "Vessel"
    },
    {
      "name": "Voyage"
    },
    {
      "name": "Selected Routes"
    },
    {
      "name": "Suggested Routes"
    },
    {
      "name": "Favorite Vessels"
    },
    {
      "name": "Waypoints"
    }
  ]
}