EN-64: Adding public endpoints description

README.md

@@ -27,8 +27,10 @@ Read registered resources:
  - `GET /meta-data`: List registered meta-data.
  - `GET /meta-groups`: List registered meta-data.
  - `GET /product-categories`: List registered product-categories.
+ - `GET /public-companies`: List registered companies.
+ - `GET /public-loads`: List registered loads.
  - `GET /public-load-attachments/download/:id`: Downloads the attachment of the load identified by Id.
- - `GET /public-vehicles`: List registered product-categories.
+ - `GET /public-vehicles`: List registered vehicles.
  - `GET /states`: List registered states.
 
 All these endpoints support the following parameters (except for those with `public-` as prefix, for example `public-vehicles`):
@@ -37,6 +39,26 @@ All these endpoints support the following parameters (except for those with `pub
  - `/:id` : Read specific resource identified by Id.
  - `/find?regex=xxx` : List resources that matches with regex (support pagination).
 
+### GET /public-companies
+
+Get public fields from registered companies.
+
+ - `GET /shipper`: List registered shippers that are not hidden only.
+ - `GET /carrier`: List registered carriers that are not hidden only.
+
+### GET /public-loads
+
+Get public fields from registered loads.
+
+ - `GET /`: List only loads with status Published.
+
+### GET /public-vehicles
+
+Get public fields from registered vehicles.
+
+ - `GET /published`: List only latest published vehicles.
+ - `GET /location`: List only location from vehicles in status Free.
+
 ## Private Endpoints
 
 The following list of endpoints requires a JWT.