Fix routings and docs

haimkastner · haimkastner · commit 2475bec2cce6 · 2020-11-09T22:22:19.000+02:00
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ Simple, light-weight server for RF commands (such as: IR, 433 MHz etc.) for appl
 * In project directory press `poetry install`
 * Create MongoDB  database named `ir-commands`.
 * Create collection named `commands`.
-* Set `DATABASE_URL` environment variable the MongoDB URL,
+* Set the `DATABASE_URL` environment variable the MongoDB URL,
 * Run it using `poetry run python src/app.py`.
 * In production run is recommended to use `gunicorn` see [gunicorn page](https://pypi.org/project/gunicorn/).
 
@@ -20,10 +20,19 @@ The Server is Build with Python, with the Flask framework for the HTTP Routing,
 If you have a project that uses RF commands for appliances (For example, see my great project [casanet](https://github.com/casanet/casanet-server)), worry no more! this project will help with storing and fetching commands on demand.
 With simple RESTfull API, you will be able the get all the available devices in the system, and their known commands.
 
-# stages
-## Stage A
-The DB will be close for uploading, and we will upload them manually.
-you will be able to get the list of all the devices and their known commands. the data will be mostly for Air-conditioning. 
-## Stage B
-The DB will be open for everyone to upload their data, hopefully for other types of devices. also, the API will allow you to search the device you need with a single recording of your device-command.
-another expansion planned for stage B is receiving all devices commands by type of command (i.e. Turn-off, Turn-on), as a way to try to detect the type of your device.
+# data access & manipulation
+Anyone can access the API, but to manipulate the data the request need to authorized by the [remote server](https://github.com/casanet/remote-server) as a valid local user
+by adding an `local_server_key_header` header contains the local server certificate `mac_address:local_server_api_secret_key`.
+
+To allow it, set `REMOTE_SERVER_URL` environment variable contained the remote server URL and `RF_REPOSITORY_API_KEY` with same key in the remote server to validate Rf commands validations requests, see [.env.example](./.env.example) for example.
+
+# API (quick review)
+ - GET /devices
+ - POST /devices json=`{ brand : string, model: string, category: string, commands: object }`
+ - PUT /devices/{brand}/{model} json=`{ brand : string, model: string, category: string }`
+ - DELETE /devices/{brand}/{model}
+ - GET /rf/{brand}/{model} 
+ - PUT /rf/{brand}/{model} json=`{ commands: object }`
+
+
+
diff --git a/src/route/device_route.py b/src/route/device_route.py
@@ -18,7 +18,7 @@ def create_device_route():
     return resp
 
 
-@app.route('/device/<brand>/<model>', methods=['PUT'])
+@app.route('/devices/<brand>/<model>', methods=['PUT'])
 @local_server_scope()
 @expects_json(edit_device_schema)
 def set_device_route(brand: str, model: str):
@@ -27,7 +27,7 @@ def set_device_route(brand: str, model: str):
     return resp
 
 
-@app.route('/device/<brand>/<model>', methods=['DELETE'])
+@app.route('/devices/<brand>/<model>', methods=['DELETE'])
 @local_server_scope()
 def delete_device_route(brand: str, model: str):
     delete_device(brand=brand, model=model)
