4 Details for all endpoints for LaaS automation API. This serves to allow users
5 to create bookings outside of the web UI hosted at labs.lfnetworking.org.
6 All included setup is referencing the development server hosted while in
7 beta testing for the API.
9 title: LaaS Automation API
10 termsOfService: 'http://labs.lfnetworking.org'
12 email: opnfv@iol.unh.edu
19 description: View and edit existing bookings
20 - name: Resource Inventory
21 description: Examine and manage resources in a lab
23 description: All actions for referencing
33 summary: Get all bookings belonging to user
34 description: Get all bookings belonging to the user authenticated by API key.
35 operationId: retrieveBookings
40 description: successful operation
44 $ref: '#/definitions/Booking'
46 description: Unauthorized API key
51 summary: Make booking by specifying information
52 description: Exposes same functionality as quick booking form from dashboard
53 operationId: makeBooking
61 description: the booking to create
63 $ref: '#/definitions/MakeBookingTemplate'
66 description: successful operation
68 $ref: '#/definitions/Booking'
70 description: Error in booking info
72 description: Unauthorized API key
73 '/booking/{bookingID}':
77 summary: See all info for specific booking
79 operationId: specificBooking
89 description: successful operation
91 $ref: '#/definitions/Booking'
93 description: Booking does not exist
95 description: Unauthorized API key
99 summary: Cancel booking
101 operationId: cancelBooking
111 description: successfully canceled booking
113 description: Booking does not exist
115 description: Cannnot cancel booking
117 description: Unauthorized API key
118 '/booking/{bookingID}/details':
122 summary: Get booking details
124 operationID: bookingDetails
134 description: successful operation
136 $ref: '#/definitions/Booking'
138 description: Booking does not exist
140 description: Unauthorized API key
141 '/booking/{bookingID}/extendBooking/{days}':
145 summary: Extend end date of booking
147 operationId: extendBooking
159 description: successful operation
161 $ref: '#/definitions/Booking'
163 description: Booking to extend does not exist
165 description: Cannot extend Booking
167 description: Unauthorized API key
168 '/resource_inventory/{templateLabID}/images':
172 summary: See valid images for a resource template
174 operationId: viewImages
184 description: successful operation
186 $ref: '#/definitions/Image'
188 description: Resource Template does not exist
190 description: Unauthorized API key
191 /resource_inventory/availableTemplates:
195 summary: All Resource Templates currently available
197 operationId: listTemplates
202 description: successful operation
204 $ref: '#/definitions/ResourceTemplate'
206 description: Unauthorized API key
211 summary: See all public users that can be added to a booking
213 operationId: getUsers
218 description: successful operation
222 $ref: '#/definitions/UserProfile'
224 description: Unauthorized API key
229 summary: List all labs and some of their info
231 operationId: listLabs
236 description: successful operation
240 $ref: '#/definitions/Lab'
242 description: Unauthorized API Key
247 summary: Get all users that are visible to a lab for operational purposes
249 operationId: labUsers
261 description: successful
264 $ref: '#/definitions/UserProfile'
266 description: invalid lab id
305 description: username of the referred user
310 description: length of the booking in days (max 21, min 1)
334 $ref: '#/definitions/UserProfile'
342 $ref: '#/definitions/Lab'
346 $ref: '#/definitions/ResourceBundle'
372 $ref: '#/definitions/Server'
410 $ref: '#/definitions/ResourceProfile'
422 $ref: '#/definitions/ResourceProfile'