fix: /event/ -> /shipment/event/; /metadata/ -> /shipment/evetn/

Author: proffapt

README.md

@@ -313,45 +313,45 @@ All the endpoints concerning shipment lie under `http://{ip/domain}/shipment/`.
 
 ### Shipment Metadata
 
-All the endpoints concerning shipment metadata lie under `http://{ip/domain}/metadata/`. 
+All the endpoints concerning shipment metadata lie under `http://{ip/domain}/shipment/metadata/`. 
 
 #### GET
 
 ##### Unique
 
-- Send a _get_ request on the endpoint with the unique id of a metadata - `/metadata/<METADATA_INT_ID>`
+- Send a _get_ request on the endpoint with the unique id of a metadata - `/shipment/metadata/<METADATA_INT_ID>`
 - cURL example:
   ```bash
-  curl -sS -X GET "http://{ip/domain}/metadata/1"
+  curl -sS -X GET "http://{ip/domain}/shipment/metadata/1"
   ```
 
 ##### All
 
-- Send a _get_ request on the endpoint with "all" as arguement - `/metadata/all`
+- Send a _get_ request on the endpoint with "all" as arguement - `/shipment/metadata/all`
 - cURL example:
   ```bash
-  curl -sS -X GET "http://{ip/domain}/metadata/all"
+  curl -sS -X GET "http://{ip/domain}/shipment/metadata/all"
   ```
 
 ##### By Shipment
 
-- Send a _get_ request on the endpoint with the unique code of a shipment - `/metadata/shipment/<SHIPMENT_CODE>`
+- Send a _get_ request on the endpoint with the unique code of a shipment - `/shipment/metadata/shipment/<SHIPMENT_CODE>`
 - cURL example:
   ```bash
-  curl -sS -X GET "http://{ip/domain}/metadata/shipment/S1"
+  curl -sS -X GET "http://{ip/domain}/shipment/metadata/shipment/S1"
   ```
 
 #### DELETE
 
-- Send a _delete_ request on the endpoint with the unique id of a metadata - `/metadata/<METADATA_INT_ID>`
+- Send a _delete_ request on the endpoint with the unique id of a metadata - `/shipment/metadata/<METADATA_INT_ID>`
 - cURL example:
   ```bash
-  curl -sS -X DELETE "http://{ip/domain}/metadata/1"
+  curl -sS -X DELETE "http://{ip/domain}/shipment/metadata/1"
   ```
 
 #### POST and PUT
 
-- Send a _post_ or a _put_ request on the endpoint (`/metadata/`) with following JSON (`application/json`) data along with `Authorization: Bearer <auth-token>` header in request body:
+- Send a _post_ or a _put_ request on the endpoint (`/shipment/metadata/`) with following JSON (`application/json`) data along with `Authorization: Bearer <auth-token>` header in request body:
   ```json
   {
     "shipment": "S1",
@@ -373,50 +373,50 @@ All the endpoints concerning shipment metadata lie under `http://{ip/domain}/met
       "temperature": "25°C",
       "quality": 95
     }' \
-    http://{ip/domain}/metadata
+    http://{ip/domain}/shipment/metadata/
   ```
 
 ### Shipment Events
 
-All the endpoints concerning shipment events lie under `http://{ip/domain}/event/`. 
+All the endpoints concerning shipment events lie under `http://{ip/domain}/shipment/event/`. 
 
 #### GET
 
 ##### Unique
 
-- Send a _get_ request on the endpoint with the unique id of an event - `/event/<EVENT_INT_ID>`
+- Send a _get_ request on the endpoint with the unique id of an event - `/shipment/event/<EVENT_INT_ID>`
 - cURL example:
   ```bash
-  curl -sS -X GET "http://{ip/domain}/event/1"
+  curl -sS -X GET "http://{ip/domain}/shipment/event/1"
   ```
 
 ##### All
 
-- Send a _get_ request on the endpoint with "all" as arguement - `/event/all`
+- Send a _get_ request on the endpoint with "all" as arguement - `/shipment/event/all`
 - cURL example:
   ```bash
-  curl -sS -X GET "http://{ip/domain}/event/all"
+  curl -sS -X GET "http://{ip/domain}/shipment/event/all"
   ```
 
 ##### By Shipment
 
-- Send a _get_ request on the endpoint with the unique code of a shipment - `/event/shipment/<SHIPMENT_CODE>`
+- Send a _get_ request on the endpoint with the unique code of a shipment - `/shipment/event/shipment/<SHIPMENT_CODE>`
 - cURL example:
   ```bash
-  curl -sS -X GET "http://{ip/domain}/event/shipment/S1"
+  curl -sS -X GET "http://{ip/domain}/shipment/event/shipment/S1"
   ```
 
 #### DELETE
 
-- Send a _delete_ request on the endpoint with the unique id of an event - `/event/<EVENT_INT_ID>`
+- Send a _delete_ request on the endpoint with the unique id of an event - `/shipment/event/<EVENT_INT_ID>`
 - cURL example:
   ```bash
-  curl -sS -X DELETE "http://{ip/domain}/event/1"
+  curl -sS -X DELETE "http://{ip/domain}/shipment/event/1"
   ```
 
 #### POST and PUT
 
-- Send a _post_ or a _put_ request on the endpoint (`/event/`) with following JSON (`application/json`) data along with `Authorization: Bearer <auth-token>` header in request body:
+- Send a _post_ or a _put_ request on the endpoint (`/shipment/event/`) with following JSON (`application/json`) data along with `Authorization: Bearer <auth-token>` header in request body:
   ```json
   {
     "shipment": "S1",
@@ -432,7 +432,7 @@ All the endpoints concerning shipment events lie under `http://{ip/domain}/event
           "shipment": "S1",
           "event": "Arrived at warehouse"
         }' \
-    http://{ip/domain}/event
+    http://{ip/domain}/shipment/event/
   ```
 
 ### Person

webapp/api/__init__.py

@@ -95,51 +95,51 @@
 
 # Endpoints related to metadata of shipment
 api.add_url_rule(
-    "/metadata/<string:id>",
+    "/shipment/metadata/<string:id>",
     view_func=shipment_metadata.get,
     methods=["GET"],
     endpoint="get_metadata"
 )
 api.add_url_rule(
-    "/metadata/shipment/<string:code>",
+    "/shipment/metadata/shipment/<string:code>",
     view_func=shipment_metadata.get_all_by_shipment,
     methods=["GET"],
     endpoint="get_metadata_by_shipment"
 )
 api.add_url_rule(
-    "/metadata/<int:id>",
+    "/shipment/metadata/<int:id>",
     view_func=shipment_metadata.delete,
     methods=["DELETE"],
     endpoint="delete_metadata"
 )
 api.add_url_rule(
-    "/metadata",
+    "/shipment/metadata",
     view_func=shipment_metadata.create_or_update,
     methods=["POST", "PUT"],
     endpoint="create_or_update_metadata"
 )
 
 # Endpoints related to events of shipment
 api.add_url_rule(
-    "/event/<string:id>",
+    "/shipment/event/<string:id>",
     view_func=shipment_event.get,
     methods=["GET"],
     endpoint="get_events"
 )
 api.add_url_rule(
-    "/event/shipment/<string:code>",
+    "/shipment/event/shipment/<string:code>",
     view_func=shipment_event.get_all_by_shipment,
     methods=["GET"],
     endpoint="get_events_by_shipment"
 )
 api.add_url_rule(
-    "/event/<int:id>",
+    "/shipment/event/<int:id>",
     view_func=shipment_event.delete,
     methods=["DELETE"],
     endpoint="delete_events"
 )
 api.add_url_rule(
-    "/event",
+    "/shipment/event",
     view_func=shipment_event.create_or_update,
     methods=["POST", "PUT"],
     endpoint="create_or_update_events"