sendnodes.yaml

swagger: '2.0'
info:
  version: '1.0'
  title: "Seat&Meals API"
  description: API for the university canteen. It allows to visualize the list of the seats available, to book a seat, to visualize the canteen menu and to make reviews about it. All APIs are tested with request data passed trough 'query params' section in Postman.   
  license: 
    name: Seat&Meals API
    url: https://github.com/Spanix98/ingso2
  contact:
    email: fabio.spano@studenti.unitn.it
host: bookmealunitn.herokuapp.com
basePath: /
tags: 
- name: "USERS"
- name: "MEALS"
- name: "SEATS"
- name: "BOOKS"
- name: "REVIEWS"

schemes:
- http
consumes:
- application/json
produces:
- application/json
paths:
  /api/v1/users:
    post:
      tags:
      - "Users"
      summary: "Create new user"
      description: "The user can create a new user by putting the email and the id."
      operationId: "addUser"
      parameters:
      - in: query
        name: email
        description: "The user email. Example: france@gmail.com"
        type: string
        required: true
      - in: query
        name: mat
        description: "The user id. Example: 111111"
        type: string
        required: true
          
      responses:
        201:
          description: "User correctly created"
          schema:
            type: object
            items:
              $ref: '#/definitions/userview'
            example:
              - email: francesco@gmail.com
                mat: 111111
        400:
          description: "ERROR 400: User not created maybe for a mistake in the query params!" 
        500:
          description: "ERROR 500: Local server error"
    get:
      tags:
      - "Users"
      summary: "View all the users"
      description: "For each user are shown the email and the id."
      operationId: "showAllUsers"
      responses:
        200:
          description: "List of users found!"
          schema:
            type: array
            items:
              $ref: '#/definitions/userview'
            example:
              - email: france@gmail.com
                mat: 111112
              - email: fabio@yahoo.it
                mat: 111111
        404:
          description: "No users found!"
        500:
          description: "ERROR 500: Local server error"
    delete:
      tags:
      - "Users"
      summary: "Delete all the users"
      description: "All the users are eliminated."
      operationId: "deleteAllUsers"
      responses:
        200:
          description: "All users are cancelled"
        404:
          description: "ERROR 404: All users are already cancelled"
        500:
          description: "ERROR 500: Local server error"
    put:
      tags:
      - "User"
      summary: "Update the user who has that id."
      description: "The user email is modified"
      operationId: "updateUser"
      parameters:
        - in: query
          name: email
          description: "The user email. Example: fra@gmail.com"
          type: string
          required: true
        - in: query
          name: mat
          description: "The user id. Example: 111111"
          type: string
          required: true
      responses:
        201:
          description: "User correctly modified"
        400:
          description: "User not found"
        500:
          description: "ERROR 500: Local server error"
        
  /api/v1/users/{user_mat}:
    get:
      tags:
      - "Users"
      summary: "View the user information."
      description: "The user is shown."
      operationId: "showUser"
      parameters:
        - in: "path"
          name: "user_mat"
          description: "Id of the user to get"
          required: true
          type: "string"
          format: "string"
      responses:
        200:
          description: "User correctly found"
          schema:
            type: object
            items:
              $ref: '#/definitions/userview'
            example:
              - email: francesco@gmail.com
                mat: 111110
        404:
          description: "User not found"
        500:
          description: "ERROR 500: Local server error"
          
    delete:
      tags:
      - "User"
      summary: "Delete the user"
      description: "The user is eliminated"
      operationId: "deleteUser"
      parameters:
        - in: "path"
          name: "user_mat"
          description: "ID of user to delete"
          required: true
          type: "string"
          format: "string64"
      responses:
        200:
          description: "Successfully deleted"
        404:
          description: "Invalid matricola"
        500:
          description: "ERROR 500: Local server error"

  /api/v1/meals:
    post:
      tags:
      - "Meals"
      summary: "Create a new meal"
      description: "The administrator creates a new meal for a specific date. You can put one meal for date."
      operationId: "addMeals"
      parameters:
      - in: query
        name: first
        description: "The first plate. Example: pasta"
        type: string
        required: true
      - in: query
        name: second
        description: "The second plate. Example: carne"
        type: string
        required: true
      - in: query
        name: dessert
        description: "The dessert. Example: torta"
        type: string
        required: true
      - in: query
        name: date
        description: "The date of the meal. Example: dd-mm-yyyy"
        type: string
        required: true

      responses:
        201:
          description: "Meal correctly created"
        400:
          description: "ERROR 400: Meal not created. There is a mistake in the syntax"
        500:
          description: "ERROR 500: Local server error"
      
    get:
      tags:
      - "Meals"
      summary: "View all the meals"
      description: "Meals are shown."
      operationId: "showAllMeals"
      responses:
        200:
          description: "Meals found!"
          schema:
            type: array
            items:
              $ref: '#/definitions/mealview'
            example:
              - first: pasta
                second: carne
                dessert: budino
                date: 11-11-2011
                mealid: 65vhsfbhj
              - first: riso
                second: pesce
                dessert: frutta
                date: 08-06-2019
                mealid: 65vhdfbhj
        404:
          description: "ERROR 404: No meals found!"
        500:
          description: "ERROR 500: Local server error"
        
    delete:
      tags:
      - "Meals"
      summary: "Delete all the meals"
      description: "Delete the entire list of meals"
      operationId: "deleteMeals"
      responses:
        200:
          description: "All meals are cancelled"
        400:
          description: "ERROR 404: All meals are already cancelled"
        500:
          description: "ERROR 500: Local server error"
        
  /api/v1/meals/{date}:
    get:
      tags:
      - "Meals"
      summary: "View a meal in a specific date."
      description: "The meal is shown."
      operationId: "showMealDate"
      parameters:
        - in: "path"
          name: "date"
          description: "Date of meal to get"
          required: true
          type: "string"
          format: "string"
      responses:
        200:
          description: "Meal correctly found!"
          schema:
            type: object
            items:
              $ref: '#/definitions/mealview'
            example:
              - first: pasta
                second: carne
                dessert: budino
                date: 11-11-2011
                mealid: 65vhsfbhj
        404:
          description: "ERROR 404: Meal not found"
        500:
          description: "ERROR 500: Local server error!"

  /api/v1/seats:
    get:
      tags:
      - "Seats"
      summary: "Return the list of all seats."
      description: "All the seats are printed."
      operationId: "getSeats"
      responses:
        200:
          description: "List of seats found!"
          schema:
            type: array
            items:
              $ref: '#/definitions/seats'
            example:
              - booked: false
                seatid: 0
              - booked: false
                seatid: 1
              - booked: true
                seatid: 2
        404:
          description: "ERROR 404: No seats found!"
        500:
          description: "ERROR 500: Local server error!"
      
    delete:
      tags:
      - "Seats"
      summary: "Delete all the seats"
      description: "All the seats are deleted"
      operationId: "deleteSeat"
      responses:
        200:
          description: "List of seats deleted!"
        400:
          description: "ERROR 404: No seats found!"
        500:
          description: "ERROR 500: Local server error!"
          
  /api/v1/seats/{nseats}:
    post:
      tags:
      - "Seats"
      summary: "Add seats"
      description: "A specific number of seats is added."
      operationId: "showSeat"
      parameters:
        - in: "path"
          name: "nseats"
          description: "Number of seats to insert"
          required: true
          type: "integer"
          format: "int64"
      responses:
        201:
          description: "Seats correctly created"
          schema:
            type: array
            items:
              $ref: '#/definitions/seats'
            example:
              - booked: false
                seatid: 0
              - booked: false
                seatid: 1
              - booked: true
                seatid: 2
        400:
          description: "ERROR 400: Seats not created!"
        500:
          description: "ERROR 500: Local server error!"
  /api/v1/books:
    get:
      tags:
      - "Books"
      summary: "Return the list of all bookings."
      description: "All the bookings are printed."
      operationId: "getBookings"
      responses:
        200:
          description: "List of books found!"
          schema:
            type: array
            items:
              $ref: '#/definitions/bookview'
            example:
              - seatid: 2
                date: 2019-12-10T18:09:16.543Z
                user: 111110
                id: 23frwbegsne
              - seatid: 5
                date: 2015-11-10T12:10:16.543Z
                user: 111111
                id: 23frvggfsne
        404:
          description: "ERROR 404: No books found!"
        500:
          description: "ERROR 500: Local server error!"
      
    delete:
      tags:
      - "Books"
      summary: "Delete all the bookings"
      description: "All the bookings are deleted"
      operationId: "deleteBookings"
      responses:
        200:
          description: "List of books deleted!"
        400:
          description: "ERROR 404: No books found!"
        500:
          description: "ERROR 500: Local server error!"
          
  /api/v1/books/{user_mat}:
    post:
      tags:
      - "Books"
      summary: "Create a seat booking."
      description: "The user books a seat in the canteen. You can book a seat which is not already booked. The booking duration is of one day."
      operationId: "addBooking"
      parameters:
      - in: "path"
        name: "user_mat"
        description: "Id of the user who are making the booking"
        required: true
        type: "string"
        format: "string"
      - in: query
        name: seatid
        description: "The seat id. Examle: 3"
        type: integer
        required: true

      responses:
        201:
          description: "Seats correctly booked"
        400:
          description: "ERROR 400: Seats does not exist or it is already booked"
        404:
          description: "ERROR 404: User not found"
        500:
          description: "ERROR 500: Local server error!"
    get:
      tags:
      - "Books"
      summary: "View the bookings of that user"
      description: "Booking are shown"
      operationId: "showBooksUser_mat"
      parameters:
        - in: "path"
          name: "user_mat"
          description: "ID of user to get"
          required: true
          type: "string"
          format: "string"
      responses:
        200:
          description: "List of books found!"
          schema:
            type: array
            items:
              $ref: '#/definitions/bookview'
            example:
              - seatid: 2
                date: 2019-12-10T18:09:16.543Z
                user: 111110
                id: 23frwbegsne
              - seatid: 5
                date: 2015-11-10T12:10:16.543Z
                user: 111111
                id: 23frwbegsne
        404:
          description: "ERROR 404: No books found or user incorrect!"
        500:
          description: "ERROR 500: Local server error!"
    put:
      tags:
      - "Books"
      summary: "Update a booking of the user inserted and the id specified."
      description: "The booking is update. The seat is changed if the inserted one is not already booked."
      operationId: "updateBooking"
      parameters:
        - in: "path"
          name: "user_mat"
          description: "ID of user to get"
          required: true
          type: "string"
          format: "string"
        - in: query
          name: bookid
          description: "The booking id. Examle: 1gwejnbvjibijgsh734i8"
          type: string
          required: true
        - in: query
          name: seatid
          description: "The seat id. Examle: 4"
          type: integer
          required: true
      responses:
        200:
          description: "Book changed!"
        400:
          description: "ERROR 400: Book not changed because the user was incorrect or the booking does not exist!"
        500:
          description: "ERROR 500: Local server error!"
  /api/v1/reviews:
    post:
      tags:
      - "Reviews"
      summary: "Create a new review"
      description: "The user creates a new review for a specific meal. In case of errors the review will not be created. If the review is refered to a future meals, the system won't insert it."
      operationId: "addReviews"
      parameters:
      - in: query
        name: review
        description: "The text of the review. Examle: blablabla"
        type: string
        required: true
      - in: query
        name: mealDate
        description: "The date of the meal. Examle: dd-mm-yyyy"
        type: string
        required: true

      responses:
        201:
          description: "Review correctly created"
        400:
          description: "ERROR 400: Review not created, probably no review written or the meal date is incorrect!"
        500:
          description: "ERROR 500: Local server error"
    get:
      tags:
      - "Reviews"
      summary: "Return the list of all reviews."
      description: "All the reviews are printed."
      operationId: "getReviews"
      responses:
        200:
          description: "Reviews found!"
          schema:
            type: array
            items:
              $ref: '#/definitions/reviewview'
            example:
              - date: 2019-12-10T18:09:16.543Z
                reviewText: blablabla
                mealDate: 09-12-2018
                reviewid: 12sfvaagbne
              - date: 2011-10-10T18:10:16.543Z
                reviewText: blabla
                mealDate: 09-12-2018
                id: 12sfhyibne
        404:
          description: "ERROR 404: No reviews found!"
        500:
          description: "ERROR 500: Local server error!"
    delete:
      tags:
      - "Reviews"
      summary: "Delete all the reviews"
      description: "All the reviews are deleted"
      operationId: "deleteReviews"
      responses:
        200:
          description: "All reviews are cancelled"
        400:
          description: "ERROR 404: All reviews are already cancelled"
        500:
          description: "ERROR 500: Local server error!"
  /api/v1/reviews/{review_id}:
    get:
      tags:
      - "Reviews"
      summary: "View a review with a specific id."
      description: "The review is shown."
      operationId: "showReviewById"
      parameters:
        - in: "path"
          name: "review_id"
          description: "Id of review to get"
          required: true
          type: "string"
          format: "string"
      responses:
        200:
          description: "Review correctly found!"
          schema:
            type: object
            items:
              $ref: '#/definitions/reviewview'
            example:
              - date: 2019-12-10T18:09:16.543Z
                reviewText: blablabla
                mealDate: 09-12-2018
                reviewid: 12sfvaagbne
        404:
          description: "ERROR 404: Review not found!"
        500:
          description: "ERROR 500: Local server error!"
      
  
definitions:

  userview:
    type: "object"
    properties:
      email:
        type: "string"
      mat:
        type: "string"
      
  mealview:
    type: "object"
    properties:
      first:
        type: "string"
      second:
        type: "string"
      dessert:
        type: "string"
      date:
        type: "string"
      mealid:
        type: "string"
        
  bookview:
    type: "object"
    properties:
      seatid:
        type: "integer"
      date:
        type: "string"
      user:
        type: "string"
      id:
        type: "string"
        
  reviewview:
    type: "object"
    properties:
      date:
        type: "string"
      reviewText:
        type: "string"
      mealDate:
        type: "string"
      reviewid:
        type: "string"
      
  seats:
    type: "object"
    properties:
      seatid:
        type: "integer"
      booked:
        type: "boolean"
      
  ApiResponse:
    type: "object"
    properties:
      code:
        type: "integer"
        format: "int32"
      type:
        type: "string"
      message:
        type: "string"