swagger.json

{
  "openapi": "3.0.0",
  "info": {
    "title": "Destiny-Ghost API",
    "version": "2.3.0",
    "description": "A Node Express application for receiving SMS/MMS Notifications around changes to the vendor wares in Bungie's Destiny and make ad-hoc queries in the database.",
    "license": {
      "name": "MIT",
      "url": "https://choosealicense.com/licenses/mit"
    }
  },
  "paths": {
    "/destiny/currentUser": {
      "get": {
        "summary": "Get the currently authenticated user.",
        "tags": [
          "Destiny"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns current user details."
          },
          "401": {
            "description": "Unauthorized"
          }
        }
      }
    },
    "/destiny/grimoireCards/{numberOfCards}": {
      "get": {
        "summary": "Get a random selection of Grimoire Cards.",
        "tags": [
          "Destiny"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "numberOfCards",
            "schema": {
              "type": "number"
            },
            "required": true,
            "description": "The number of cards to return. (Max. 10)"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns a random selection of Grimoire Cards."
          },
          "400": {
            "description": "Invalid whole number between 1 and 10."
          },
          "422": {
            "description": "Unrecognized whole number."
          }
        }
      }
    },
    "/destiny/manifest": {
      "get": {
        "summary": "Get details about the latest Destiny manifest definition.",
        "tags": [
          "Destiny"
        ],
        "parameters": [
          {
            "name": "If-Modified-Since",
            "in": "head"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the Destiny Manifest definition."
          }
        }
      },
      "post": {
        "summary": "Download the latest Destiny manifest if the local copy is outdated.",
        "tags": [
          "Destiny"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the Destiny Manifest definition."
          }
        }
      }
    },
    "/destiny2/characters": {
      "get": {
        "summary": "Get a list of the user's characters.",
        "tags": [
          "Destiny 2"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the current user's list of characters."
          },
          "401": {
            "description": "Unauthorized"
          }
        }
      }
    },
    "/destiny2/inventory": {
      "get": {
        "summary": "Get the complete inventory of items.",
        "tags": [
          "Destiny 2"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the complete Destiny 2 item inventory."
          }
        }
      }
    },
    "/destiny2/manifest": {
      "get": {
        "summary": "Get details about the latest Destiny 2 manifest definition.",
        "tags": [
          "Destiny 2"
        ],
        "parameters": [
          {
            "name": "If-Modified-Since",
            "in": "head"
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the Destiny Manifest definition."
          }
        }
      },
      "post": {
        "summary": "Download the latest Destiny2 manifest if the local copy is outdated.",
        "tags": [
          "Destiny 2"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the Destiny Manifest definition."
          },
          "403": {
            "description": "Forbidden"
          }
        }
      }
    },
    "/destiny2/xur": {
      "get": {
        "summary": "Get Xur's inventory if available.",
        "tags": [
          "Destiny 2"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns Xur's inventory."
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Xur could not be found."
          }
        }
      }
    },
    "/health": {
      "get": {
        "summary": "Get a summary of the status of the Destiny Ghost API and its dependencies.",
        "tags": [
          "Health"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the status reports of underlying dependencies."
          },
          "503": {
            "description": "Service is unavailable."
          }
        }
      }
    },
    "/health/metrics": {
      "get": {
        "summary": "Get metrics on the health of the Destiny Ghost API.",
        "tags": [
          "Health"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns measurements."
          }
        }
      }
    },
    "/users/{emailAddress}/emailAddress": {
      "get": {
        "summary": "Get the Destiny Ghost user by email address.",
        "tags": [
          "Users"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "emailAddress",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "The email address of the Destiny Ghost user."
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "204": {
            "description": "Destiny Ghost user found."
          },
          "404": {
            "description": "No Destiny Ghost user found."
          }
        }
      }
    },
    "/users/{phoneNumber}/phoneNumber": {
      "get": {
        "summary": "Get the Destiny Ghost user by phone number.",
        "tags": [
          "Users"
        ],
        "parameters": [
          {
            "in": "path",
            "name": "phoneNumber",
            "schema": {
              "type": "string"
            },
            "required": true,
            "description": "The phone number of the Destiny Ghost user."
          }
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "204": {
            "description": "Destiny Ghost user found."
          },
          "404": {
            "description": "No Destiny Ghost user found."
          }
        }
      }
    },
    "/users/current": {
      "get": {
        "summary": "Get the current Destiny Ghost user.",
        "tags": [
          "Users"
        ],
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "Returns the current Destiny Ghost user's profile."
          },
          "401": {
            "description": "Unauthorized"
          },
          "404": {
            "description": "Destiny Ghost profile for the current user was not found."
          }
        }
      }
    }
  },
  "components": {},
  "tags": []
}