Challenge Overview
Welcome to the Meli API Architecture Challenge! We are looking to leverage Apiary to design, document, and test REST APIs for an upcoming data center management application.
We've pieced together some of the initial service details, and are looking to you to create the polished API Blueprint. Please review the attached API specs to create an Aviary API Blueprint file. Be sure to include sample Requests and/or Responses.
Details
1. See API Documentation spec
2. Use JSON formats
3. Include error handling in your documentation. What happens if we have a malformed request or an error occurs on the server?
4. Take into consideration that the users of this API will likely be AngularJS apps. Please make the response structure easy to work with from a JavaScript perspective.
If you have any recommendations outside of the specs (e.g. any API Design Best Practices we need?), please suggest/discuss them via the challenge forums. You are also welcome to add them to your submission, but we may ask to have them changed during Final Fix.
Final Submission Guidelines
Using Apiary
1. Sign up for a free Apiary account
2. "Create a New API" for the datacenter APIs
3. Feel free to set to "Private" under Settings
4. Write up the documentation in the format expected by Apiary (See API Blueprint Syntax)
Submission Deliverables
1. Raw text file of Apiary API Blueprint (file named "apiary.apib"