swagger_output.json

{
  "swagger": "2.0",
  "info": {
    "version": "1.0.0",
    "title": "My API",
    "description": "Documentation automatically generated by the <b>swagger-autogen</b> module."
  },
  "host": "localhost:3000",
  "basePath": "/",
  "tags": [
    {
      "name": "Post",
      "description": "Endpoints"
    },
    {
      "name": "Station",
      "description": "Endpoints"
    },
    {
      "name": "User",
      "description": "Endpoints"
    }
  ],
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/getAll": {
      "get": {
        "tags": [
          "Station"
        ],
        "description": "Endpoint to get all stations",
        "parameters": [],
        "responses": {
          "200": {
            "description": "all stations.",
            "schema": {
              "$ref": "#/definitions/Station"
            }
          }
        }
      }
    },
    "/insert": {
      "post": {
        "tags": [
          "Station"
        ],
        "description": "Endpoint to insert a station",
        "parameters": [
          {
            "name": "newStation",
            "in": "body",
            "description": "Information about the station",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Station"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "insered station.",
            "schema": {
              "$ref": "#/definitions/Station"
            }
          }
        }
      }
    },
    "/getNearStaions/{longitude}/{latitude}": {
      "get": {
        "tags": [
          "Station"
        ],
        "description": "Endpoint to get all stations in a round of 5000m to the center",
        "parameters": [
          {
            "name": "longitude",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "center longitude"
          },
          {
            "name": "latitude",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "center latitude"
          }
        ],
        "responses": {
          "200": {
            "description": "near station.",
            "schema": {
              "$ref": "#/definitions/Station"
            }
          }
        }
      }
    },
    "/{stationId}": {
      "patch": {
        "tags": [
          "Station"
        ],
        "description": "Endpoint to update a specific station",
        "parameters": [
          {
            "name": "stationId",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "ID of a station"
          },
          {
            "name": "updatedStation",
            "in": "body",
            "description": "Information about the station",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Station"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "a specific station.",
            "schema": {
              "$ref": "#/definitions/Station"
            }
          }
        }
      }
    },
    "/": {
      "get": {
        "tags": [
          "User"
        ],
        "description": "Endpoint to get all users only Authenticated user is an admin",
        "parameters": [
          {
            "name": "authorization",
            "in": "header",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          }
        }
      }
    },
    "/{postId}": {
      "get": {
        "tags": [
          "Post"
        ],
        "description": "Endpoint to get a specific post",
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "ID of a post"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "delete": {
        "tags": [
          "Post"
        ],
        "description": "Endpoint to delete a specific post",
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "ID of a post"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      },
      "patch": {
        "tags": [
          "Post"
        ],
        "description": "Endpoint to update a specific post",
        "parameters": [
          {
            "name": "postId",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "ID of a post"
          },
          {
            "name": "body",
            "in": "body",
            "schema": {
              "type": "object",
              "properties": {
                "title": {
                  "example": "any"
                },
                "description": {
                  "example": "any"
                }
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/register": {
      "post": {
        "tags": [
          "User"
        ],
        "description": "Endpoint to insert a user",
        "parameters": [
          {
            "name": "newUser",
            "in": "body",
            "description": "Information about the user",
            "required": true,
            "schema": {
              "$ref": "#/definitions/User"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "insered user.",
            "schema": {
              "$ref": "#/definitions/User"
            }
          }
        }
      }
    },
    "/authenticate": {
      "post": {
        "tags": [
          "User"
        ],
        "description": "Endpoint to authenticate a user",
        "parameters": [
          {
            "name": "newUser",
            "in": "body",
            "description": "Information about the user",
            "required": true,
            "schema": {
              "$ref": "#/definitions/User"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "400": {
            "description": "Bad Request"
          }
        }
      }
    },
    "/{username}": {
      "get": {
        "tags": [
          "User"
        ],
        "description": "Endpoint to get all users only Authenticated users",
        "parameters": [
          {
            "name": "username",
            "in": "path",
            "required": true,
            "type": "string"
          },
          {
            "name": "authorization",
            "in": "header",
            "type": "string"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  },
  "definitions": {
    "Post": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "example": "this is the title of my post"
        },
        "description": {
          "type": "string",
          "example": "this is the description of my post"
        }
      },
      "required": [
        "title",
        "description"
      ]
    },
    "Station": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Central Park"
        },
        "location": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "Point"
            },
            "coordinates": {
              "type": "array",
              "example": [
                -73.97,
                40.77
              ],
              "items": {
                "type": "number"
              }
            }
          }
        }
      },
      "required": [
        "name",
        "location"
      ]
    },
    "User": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "example": "username"
        },
        "password": {
          "type": "string",
          "example": "password"
        },
        "role": {
          "type": "object",
          "properties": {
            "type": {
              "type": "string",
              "example": "Admin"
            }
          }
        }
      },
      "required": [
        "username",
        "password",
        "role"
      ]
    }
  }
}