swagger.json

{
  "swagger": "2.0",
  "info": {
    "description": "A json- / grpc- / graphql-wrapper around the inofficial API for different canteens managed by the Studentenwerk Niederbayern/Oberpfalz.",
    "version": "3.0.0",
    "title": "Studentenwerk Niederbayern/Oberpfalz Mensa API",
    "contact": {
      "email": "lukas@wolfsteiner.media"
    },
    "license": {
      "name": "GPLv3",
      "url": "https://github.com/dotWee/stwno-mensa_api/blob/master/LICENSE"
    }
  },
  "tags": [{
    "name": "Items",
    "description": "Items on the canteen menu plan"
  }, {
    "name": "Ingredients",
    "description": "Possible ingredients for menu items"
  }],
  "schemes": ["https", "http"],
  "host": "stwno-mensa-api.herokuapp.com",
  "paths": {
    "/ingredients": {
      "get": {
        "tags": ["Ingredients"],
        "summary": "Get a list of possible ingredients",
        "description": "Returns a list of possible ingredients",
        "operationId": "getIngredients",
        "produces": ["application/json"],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/Ingredients"
            }
          }
        }
      }
    },
    "/ingredients/{key}": {
      "get": {
        "tags": ["Ingredients"],
        "summary": "Get ingredient matching the supplied key",
        "description": "Returns ingredient matching the supplied key",
        "operationId": "getIngredientsForKey",
        "produces": ["application/json"],
        "parameters": [{
          "name": "key",
          "in": "path",
          "description": "Key of an ingredient",
          "required": true,
          "type": "string"
        }],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/Ingredient"
            }
          },
          "500": {
            "description": "Internal server error",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/api/items": {
      "get": {
        "tags": ["Items"],
        "summary": "Get all cached items",
        "description": "Returns a list of items of all cached items",
        "operationId": "getItems",
        "produces": ["application/json"],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/ItemsResponse"
            }
          },
          "400": {
            "description": "Bad request",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "500": {
            "description": "Internal server error",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/api/items/{location}": {
      "get": {
        "tags": ["Items"],
        "summary": "Get items of a supplied canteen",
        "description": "Returns a list of items of givien canteen",
        "operationId": "getItemsForLocation",
        "produces": ["application/json"],
        "parameters": [{
          "name": "location",
          "in": "path",
          "description": "Name of a supported canteen",
          "required": true,
          "type": "string"
        }],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/ItemsResponse"
            }
          },
          "400": {
            "description": "Bad request",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "500": {
            "description": "Internal server error",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/api/items/{location}/{day}": {
      "get": {
        "tags": ["Items"],
        "summary": "Get items of a supplied canteen on specific weekday",
        "description": "Returns a list of items of supplied canteen on specific weekday",
        "operationId": "getItemsForLocationOnDay",
        "produces": ["application/json"],
        "parameters": [{
          "name": "location",
          "in": "path",
          "description": "Name of a supported canteen",
          "required": true,
          "type": "string"
        }, {
          "name": "day",
          "in": "path",
          "description": "Weekday",
          "required": true,
          "type": "string"
        }],
        "responses": {
          "200": {
            "description": "Successful operation",
            "schema": {
              "$ref": "#/definitions/ItemsResponse"
            }
          },
          "400": {
            "description": "Bad request",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "500": {
            "description": "Internal server error",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Error": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "InvalidLocationParameterError"
        },
        "message": {
          "type": "string",
          "example": "Value for location=uni is invalid. See documentation for possible values."
        }
      }
    },
    "ErrorResponse": {
      "type": "object",
      "properties": {
        "error": {
          "$ref": "#/definitions/Error"
        }
      }
    },
    "Ingredient": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string",
          "example": "G"
        },
        "value": {
          "type": "string",
          "example": "Milch und Milchprodukte"
        }
      }
    },
    "Ingredients": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/Ingredient"
      }
    },
    "Item": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "example": "Hähnchenbrustfilet mit Pfefferrahm und Minirösti"
        },
        "date": {
          "type": "string",
          "example": "10.09.2018"
        },
        "day": {
          "type": "string",
          "example": "monday"
        },
        "category": {
          "type": "string",
          "example": "HG1"
        },
        "labels": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ingredients": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/Ingredient"
          }
        }
      }
    },
    "ItemsResponse": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/Item"
      }
    }
  },
  "externalDocs": {
    "description": "Source code",
    "url": "https://github.com/dotWee/stwno-mensa_api"
  }
}