API Readme update (#26)

* Readme update

* Update swagger and readme

* URL fix

* Update docs

---------

Co-authored-by: JoleVLF <Jovan@DESKTOP-JTIACNO>

Author: JoleVLF

README.md

@@ -51,13 +51,24 @@ docker compose up
 
 The application will be served on http://127.0.0.1:8009 (I.E. typing localhost/docs in your browser will load the swagger documentation)
 
+Full list of APIs available you can check [here](https://editor-next.swagger.io/?url=https://gist.githubusercontent.com/JoleVLF/20645c6e8e3545d02c7c4570271bdc49/raw/6efafb74bd2bc33e4221ee2a202d0c830b867c70/reporting)
 # Documentation
 <h3>POST</h3>
 
 ```
 /api/v1/openagri-report/irrigation-report/
 ```
 
+## Request Params
+
+### data
+- **Type**: `UploadFile`
+- **Description**: API processes the data directly to generate the report if data passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
+
+
+
+## Response
+
 Response is generated PDF file.
 
 
@@ -67,10 +78,24 @@ Response is generated PDF file.
 /api/v1/openagri-report/compost-report/
 ```
 
-Response is generated PDF file.
-Possible observation_type_name values = \
-["Pesticides", "Irrigation", "Fertilization", "CropStressIndicator", "CropGrowthObservation"]
+## Request Params 
+
+### observation_type_name
+- **Type**: `str`
+- **Description**: The name of the observation type for the report. The value of this parameter must be one of the following options:
+  - "Pesticides"
+  - "Irrigation"
+  - "Fertilization"
+  - "CropStressIndicator"
+  - "CropGrowthObservation"
 
+### data
+- **Type**: `UploadFile`
+- **Description**: API processes the data directly to generate the report if data is passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
+
+
+## Response 
+Response is generated PDF file.
 
 <h3> Example usage </h3>
 
@@ -85,15 +110,28 @@ When service is run wihtout Gatekeeper data must be provided in .json file forma
 
 ```
 
-Response: A generated PDF file containing the animal report.
+## Request Params
+
+### animal_group
+- **Type**: `Optional[str]`
+- **Description**: The group or category the animal belongs to. This is an optional string field, and it can be left as `None` if not applicable.
+
+### name
+- **Type**: `Optional[str]`
+- **Description**: The name of the animal. It is an optional string field, and if no name is provided, it can be set to `None`.
+
+### parcel
+- **Type**: `Optional[UUID4]`
+- **Description**: A unique identifier for a parcel, represented as a UUID4. This is an optional field that can be left empty if not required.
 
-Possible query parameters:
+### status
+- **Type**: `Optional[int]`
+- **Description**: The status code associated with the animal or the transaction. It is an optional integer field. If not specified, it defaults to `None`.
+
+### data
+- **Type**: `UploadFile`
+- **Description**: API processes the data directly to generate the report if data passed. This parameter is not required and when it is, must be provided as an `UploadFile`.
 
-animal_group (Optional, string): Specifies the group of animals to include in the report.
-name (Optional, string): Filters results by animal name.
-parcel (Optional, UUID4): Identifies the specific parcel where the animals are located.
-status (Optional, integer): Filters animals by their status.
-Example Usage
 The Animal Report API can be used with or without Gatekeeper support:
 
 With Gatekeeper: The data file parameter can be ignored.
@@ -102,6 +140,10 @@ If no data file is provided and Gatekeeper is not enabled, the API fetches data
 
 If a valid JSON file is uploaded, the API processes the data directly to generate the report
 
+## Response
+
+Response is generated PDF file.
+
 <h2>Pytest</h2>
 Pytest can be run on the same machine the service has been deployed to by moving into the tests dir and running: