| Name: |
Preliminary Documentation |
| Description: |
The FRC Events API documentation is ready for review, in its preliminary format. Please read through the following notes as well as the notes included in the documentation itself in detail before you begin development or post inquiries to TeamForge. Please note that this is specific to the data request/response portion of the API, and information about the notification service will be released at a later time.
The documentation is still a living, breathing artifact, and will be changing from time to time while we continue development. As it states, please do not make any assumptions about the final naming and formats, routes, etc of the various APIs. While we don't anticipate major changes to what is shown, things may arise that necessitate changes. Until we officially release the production version, we will not be using or incrementing a version number.
We are using a service called Apiary for our documentation. Apiary allows us to have a version on the web (instead of a download document) so that we can make changes as needed and our community developers can view the most up to date information possible. Additionally, Apiary allows you to see example implementations in over 10 languages that you could use as a starting point for ideas about how to implement your own project. On the API which you are interested in, click the "GET" tab (or anywhere on the box with the parameters in it) and a lower panel will appear with request/response examples. Full examples are shown in xml and json for valid requests, and possible errors are shown as pure text underneath the responses.
On Apiary, there is a "Comments" tab directly within the page. However, please use TeamForge as it will help create a more centralized source for questions and comments. On the right side of the page, there is an address for a "Mock Server". This is a super cool feature that will allow you to make calls against Apiary and it will replicate a response accordingly. Please read the notes about the mock server on the top of the documentation- most importantly, there is no validation on parameters in the mock server, but there is in production.
You can check out the preliminary documentation here:
http://docs.frceventsprelim.apiary.io/
As always, please use the discussion and trackers areas to provide your feedback and questions. We appreciate your help and look forward to continued development of this valuable tool for our community. |
|
| Status: |
Active |
| Maturity: |
Obsolete |
| Related Planning Folders: |
|
|
15
25