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}/extendBooking/{days}':
122 summary: Extend end date of booking
124 operationId: extendBooking
136 description: successful operation
138 $ref: '#/definitions/Booking'
140 description: Booking to extend does not exist
142 description: Cannot extend Booking
144 description: Unauthorized API key
145 '/resource_inventory/{templateLabID}/images':
149 summary: See valid images for a resource template
151 operationId: viewImages
161 description: successful operation
163 $ref: '#/definitions/Image'
165 description: Resource Template does not exist
167 description: Unauthorized API key
168 /resource_inventory/availableTemplates:
172 summary: All Resource Templates currently available
174 operationId: listTemplates
179 description: successful operation
181 $ref: '#/definitions/ResourceTemplate'
183 description: Unauthorized API key
188 summary: See all public users that can be added to a booking
190 operationId: getUsers
195 description: successful operation
199 $ref: '#/definitions/UserProfile'
201 description: Unauthorized API key
206 summary: List all labs and some of their info
208 operationId: listLabs
213 description: successful operation
217 $ref: '#/definitions/Lab'
219 description: Unauthorized API Key
224 summary: Get all users that are visible to a lab for operational purposes
226 operationId: labUsers
238 description: successful
241 $ref: '#/definitions/UserProfile'
243 description: invalid lab id
282 description: username of the referred user
287 description: length of the booking in days (max 21, min 1)
311 $ref: '#/definitions/UserProfile'
319 $ref: '#/definitions/Lab'
323 $ref: '#/definitions/ResourceBundle'
349 $ref: '#/definitions/Server'
387 $ref: '#/definitions/ResourceProfile'
399 $ref: '#/definitions/ResourceProfile'