| Name: |
Release Candidate (2015) |
| Description: |
Hello Community Developers,
We have exciting news for you today: the documentation for the 2015 version of the API is now available. You can find it online using the link below. As you will see on the top of the documentation, this version is our “Release Candidate”. We intend for this documentation to match how the API will behave in the production environment. However, if we (or you) uncover any bugs or issues with the API or its documentation during the coming days, we may still make minor updates. We will continue to monitor the TeamForge site, so please post there if you have a question, or notice anything within the documentation that you believe needs to be adjusted.
The documentation currently shows “version X.X” for the API. When we have leave the Release Candidate stage, the documentation and API will be updated to report “v1.0”. Once we have added the version number, the API and documentation are considered final and you will know you are coding against a known request and response pattern. We anticipate the release of version 1.0 (and having the production server available to take requests) around the beginning of February. If you have matched the documentation and used our “Mock Server” to test your products, it should be a relatively simple transition come the end of the month.
In the future, we will increment the version number and publish new documentation with new features as they become available. Please take note of how to include the version number in your API calls- the production server will require you to add “v1.0” (or whichever version number) when you make requests or else it won’t return anything. Additionally, the URL (“Mock Server”) on the right side bar of Apiary allows you to test your code against the current API documentation. That data it returns is just hard-coded though, so there is no validation of the parameters and you won’t receive “dynamic” data in return. This is expected, and not a “bug”, it is just a testing tool for you to use if you wish.
If you are not familiar with Apiary, it is the tool that we use to power our documentation and demos. You can take a look at rel1117 under “Preliminary Documentation” for details about Apiary and how it works.
http://docs.frcevents.apiary.io/
As always, please use our TeamForge site to enter any bugs or comments you may have. We also encourage the use of discussion area to coordinate projects or ask questions of other community developers.
Happy coding!
-The FMS Team |
|
| Status: |
Active |
| Maturity: |
Pre-General Availability |
| Related Planning Folders: |
|
|
15
100