Create RAML and/or Swagger file describing Admin API

[brylie]

Create an Admin API description file in either Swagger or RAML format. Restlet Studio can be used to visually design this file.

Definition of done

• Demonstrate comprehension of existing Admin API structure
• Create Swagger or RAML file describing all Admin API endpoints, methods, parameters, etc

[brylie]

There is a related issue on the API Umbrella issue queue.

[ccsr]

@brylie I am bit confused with this. Why are we spending time on creating Swagger or RAML for Admin API? I understood that we need to have mechanism to create Swagger and or RAML for the APIs which are hosted on APInf. May be I dont understand the whole context here. Please help me understand.

[brylie]

The API Umbrella Admin API lacks documentation. When this task was created, we were trying to figure out how to understand all available Admin API methods. Nick has responded to the previously mentioned issue regarding API Umbrella Admin API documentation in a related issue, and seems willing to document the endpoints himself.