Advertisement
Not a member of Pastebin yet?
Sign Up,
it unlocks many cool features!
- swagger: "2.0"
- info:
- description: "Sample server that handles the bowling center alley managment"
- version: "1.0.0"
- title: "Bowling alley center managment system"
- termsOfService: "http://swagger.io/terms/"
- contact:
- email: "210274@student.pwr.edu.pl"
- license:
- name: "Apache 2.0"
- url: "http://www.apache.org/licenses/LICENSE-2.0.html"
- host: "bowlingalley.swagger.io"
- basePath: "/v2"
- tags:
- - name: "reservation"
- - name: "user"
- paths:
- /center/reservation:
- get:
- tags:
- - "reservation"
- summary: "Get all the reservations "
- description: "returns reservations"
- operationId: "getReservations"
- produces:
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- description: "get list of reservations"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/Reservation"
- responses:
- default:
- description: "successful operation"
- post:
- tags:
- - "reservation"
- summary: "Add a new reservation"
- description: ""
- operationId: "addReservation"
- consumes:
- - "application/json"
- - "application/xml"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- description: "Reservation that has to be added to list of reservations"
- required: true
- schema:
- $ref: "#/definitions/Reservation"
- responses:
- 405:
- description: "Invalid input"
- security:
- - reservation_auth:
- - "write:reservations"
- - "read:reservations"
- put:
- tags:
- - "reservation"
- summary: "Update an existing reservation"
- description: ""
- operationId: "updateReservation"
- consumes:
- - "application/json"
- - "application/xml"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- description: "Reservation that has to be updated"
- required: true
- schema:
- $ref: "#/definitions/Reservation"
- responses:
- 400:
- description: "Invalid ID supplied"
- 404:
- description: "Reservation not found"
- 405:
- description: "Validation exception"
- security:
- - reservation_auth:
- - "write:reservations"
- - "read:reservations"
- /center/reservation/{userId}:
- get:
- tags:
- - "reservation"
- summary: "Find all reservations for certain user"
- description: "insert user id to find all reservations assigned to it"
- operationId: "getReservationByUser"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "userId"
- in: "path"
- description: "user ID that we want to get reservations for"
- required: true
- type: "integer"
- maximum: 10.0
- minimum: 1.0
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- $ref: "#/definitions/Reservation"
- 400:
- description: "Invalid ID supplied"
- 404:
- description: "User not found"
- /center/reservation/track/{trackId}:
- get:
- tags:
- - "reservation"
- summary: "Find all reservations for certain track"
- description: "insert track id to find all reservations assigned to it"
- operationId: "getReservationByTrack"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "trackId"
- in: "path"
- description: "track ID that we want to get reservations for"
- required: true
- type: "integer"
- maximum: 10.0
- minimum: 1.0
- format: "int64"
- responses:
- 200:
- description: "successful operation"
- schema:
- $ref: "#/definitions/Reservation"
- 400:
- description: "Invalid ID supplied"
- 404:
- description: "Track not found"
- delete:
- tags:
- - "reservation"
- summary: "Deletes a reservation"
- description: ""
- operationId: "deleteReservation"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "trackId"
- in: "path"
- description: "reservation id to delete"
- required: true
- type: "integer"
- format: "int64"
- responses:
- 400:
- description: "Invalid ID supplied"
- 404:
- description: "reservation not found"
- security:
- - reservation_auth:
- - "write:reservations"
- - "read:reservations"
- /user:
- post:
- tags:
- - "user"
- summary: "Create user"
- description: "This can only be done by the logged in user."
- operationId: "createUser"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- description: "Created user object"
- required: true
- schema:
- $ref: "#/definitions/User"
- responses:
- default:
- description: "successful operation"
- /user/createWithArray:
- post:
- tags:
- - "user"
- summary: "Creates list of users with given input array"
- description: ""
- operationId: "createUsersWithArrayInput"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- description: "List of user object"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/User"
- responses:
- default:
- description: "successful operation"
- /user/createWithList:
- post:
- tags:
- - "user"
- summary: "Creates list of users with given input array"
- description: ""
- operationId: "createUsersWithListInput"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - in: "body"
- name: "body"
- description: "List of user object"
- required: true
- schema:
- type: "array"
- items:
- $ref: "#/definitions/User"
- responses:
- default:
- description: "successful operation"
- /user/login:
- get:
- tags:
- - "user"
- summary: "Logs user into the system"
- description: ""
- operationId: "loginUser"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "username"
- in: "query"
- description: "The user name for login"
- required: true
- type: "string"
- - name: "password"
- in: "query"
- description: "The password for login in clear text"
- required: true
- type: "string"
- responses:
- 200:
- description: "successful operation"
- schema:
- type: "string"
- headers:
- X-Rate-Limit:
- type: "integer"
- format: "int32"
- description: "calls per hour allowed by the user"
- X-Expires-After:
- type: "string"
- format: "date-time"
- description: "date in UTC when token expires"
- 400:
- description: "Invalid username/password supplied"
- /user/logout:
- get:
- tags:
- - "user"
- summary: "Logs out current logged in user session"
- description: ""
- operationId: "logoutUser"
- produces:
- - "application/xml"
- - "application/json"
- parameters: []
- responses:
- default:
- description: "successful operation"
- /user/{username}:
- get:
- tags:
- - "user"
- summary: "Get user by user name"
- description: ""
- operationId: "getUserByName"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "username"
- in: "path"
- description: "The name that needs to be fetched. Use user1 for testing. "
- required: true
- type: "string"
- responses:
- 200:
- description: "successful operation"
- schema:
- $ref: "#/definitions/User"
- 400:
- description: "Invalid username supplied"
- 404:
- description: "User not found"
- put:
- tags:
- - "user"
- summary: "Updated user"
- description: "This can only be done by the logged in user."
- operationId: "updateUser"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "username"
- in: "path"
- description: "name that need to be updated"
- required: true
- type: "string"
- - in: "body"
- name: "body"
- description: "Updated user object"
- required: true
- schema:
- $ref: "#/definitions/User"
- responses:
- 400:
- description: "Invalid user supplied"
- 404:
- description: "User not found"
- delete:
- tags:
- - "user"
- summary: "Delete user"
- description: "This can only be done by the logged in user."
- operationId: "deleteUser"
- produces:
- - "application/xml"
- - "application/json"
- parameters:
- - name: "username"
- in: "path"
- description: "The name that needs to be deleted"
- required: true
- type: "string"
- responses:
- 400:
- description: "Invalid username supplied"
- 404:
- description: "User not found"
- securityDefinitions:
- reservation_auth:
- type: "oauth2"
- authorizationUrl: "http://bowlingalley.swagger.io/oauth/dialog"
- flow: "implicit"
- scopes:
- write:reservations: "modify reservations in your account"
- read:reservations: "read your reservations"
- api_key:
- type: "apiKey"
- name: "api_key"
- in: "header"
- definitions:
- User:
- type: "object"
- properties:
- id:
- type: "integer"
- format: "int64"
- name:
- type: "string"
- surname:
- type: "string"
- username:
- type: "string"
- email:
- type: "string"
- password:
- type: "string"
- userStatus:
- type: "string"
- description: "Indicator whether user is currently playing or not"
- enum:
- - "playing"
- - "not_playing"
- xml:
- name: "User"
- Reservation:
- type: "object"
- properties:
- id:
- type: "integer"
- format: "int64"
- used_track_id:
- type: "integer"
- format: "int64"
- time_started:
- type: "string"
- time_ending:
- type: "string"
- playing_user_id:
- type: "integer"
- format: "int64"
- xml:
- name: "Tag"
- ApiResponse:
- type: "object"
- properties:
- code:
- type: "integer"
- format: "int32"
- type:
- type: "string"
- message:
- type: "string"
- externalDocs:
- description: "Find out more about Swagger"
- url: "http://swagger.io"
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement