mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-14 03:52:21 +03:00
Code Issues Projects Releases Packages Wiki Activity

Added API roadmap.

Browse source
This commit is contained in:
Alex Tselegidis 2016-07-10 18:54:37 +02:00
parent a0600bf98c
commit abbb982edf
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/rest-api.md
View file

@ -342,7 +342,17 @@ You can also try the GET requests with your browser by navigating to the respeci
- `PUT /api/v1/settings/:name` Insert or update a setting in the database. Provide a snake_case name in order to keep the conventions. - `PUT /api/v1/settings/:name` Insert or update a setting in the database. Provide a snake_case name in order to keep the conventions.
- `DELETE /api/v1/settings/:name` Remove a setting from the database. **Notice:** Be careful when removing settings that are required by the application because this will cause error later on. - `DELETE /api/v1/settings/:name` Remove a setting from the database. **Notice:** Be careful when removing settings that are required by the application because this will cause error later on.
## API Roadmap
Although the current state should be sufficient for working with the application data there are some other features of that will make the consume more flexible and powerfull. These will be added gradually with the future releases of Easy!Appointments.
[ ] Add auto-generated links whenever external resource IDs are provided.
[ ] Add pagination header links when the client provides pagination parameters.
[ ] Add support for sub-resourcing e.g. /api/v1/customers/:id/appointments must return all the appointments of a specific customer.
[ ] Add custom filtering parameters e.g. /api/v1/appointments?book=>2016-07-10
[ ] Improved exception handling.
Feel free to make pull requests if you have the time to develop one of those.
## Troubleshooting ## Troubleshooting