Note: This topic originally presented an upcoming change to SRS timings. After reviewing your feedback we have decided to not go forward with the changes. You can find the original content of this post by reviewing the edits of this post
This information is mainly for the developers who use the API.
If you have worked with the API you may be familiar with the /srs_stages endpoint.
Due to some upcoming planned features we are going to change how this information is being delivered.
Right now the information is delivered as a
report object type. This report delivers information on a singular spaced repetition system, which is used for all the subjects.
We are going to drop the
/srs_stages endpoint and replace it with a
/spaced_repetition_systems. This endpoint will mimic our other endpoints where one can retrieve a collection of
spaced_repetition_system objects or a singular object resource.
The reason for this change is we are preparing support for multiple spaced repetition systems (systems with different timings, number of stages, and/or passing stage).
In addition to the new endpoint we will be adding a new field (most likely named
spaced_repetition_system_id) to subject objects. This association is used to determine the timing calculations for the subject and if the subject has met conditions for passing or burning. In other words, each subject will belong to one spaced repetition system.
I know we have announced API version 2 moving out of beta. But given the drastic change and how newly it is out of beta we are going to do a breaking change without versioning. There is no good way to support multiple spaced repetition systems in the current “report” set-up. This will save us the headache of not having to address this down the road.
To make this transition easy we will have a period where both
/spaced_repetition_systems exist. There will be a hard date when
/srs_stages will be dropped. Consider this an early warning.
Updated documentation on the new endpoint will be made publically at a future date.
We will keep you informed when the documentation has been updated and dates have been set. Consider joining the API mailing list to get the latest news and updates.