Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add v0.18.0 changelog #41

Merged
merged 1 commit into from
Nov 4, 2023
Merged

add v0.18.0 changelog #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@

<a name="v0.18.0"></a>
## [v0.18.0](https://github.com/GreenSpaceNASA/proto/compare/v0.17.0...v0.18.0)

> 2023-11-04

### Fix

* **makefile:** run and commit docs


<a name="v0.17.0"></a>
## [v0.17.0](https://github.com/GreenSpaceNASA/proto/compare/v0.16.0...v0.17.0)

Expand Down
53 changes: 23 additions & 30 deletions proto/greenspace/api/v1/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,17 @@
## Services


<a name="hoguera.platform.greenspace.api.v1.Bff"/>
<a name="hoguera.platform.greenspace.api.v1.GreenSpace"/>

### Bff
BFF service
### GreenSpace
GreenSpace is the service that provides all the information for NASA's GreenSpace app.

| Method Name | Description |
| ----------- | ------------|
| `GetV1` <br /><br /> Request: [.google.protobuf.Empty](#google.protobuf.Empty) <br /> Response: [V1Response](#google.protobuf.Empty) | <para></para> |


<a name="hoguera.platform.greenspace.api.v1.Internal"/>

### Internal
Internal service

| Method Name | Description |
| ----------- | ------------|
| `GetAnimals` <br /><br /> Request: [AnimalsRequest](#hoguera.platform.greenspace.api.v1.AnimalsRequest) <br /> Response: [Animal](#hoguera.platform.greenspace.api.v1.AnimalsRequest) | <para></para> |
| `GetCoast` <br /><br /> Request: [CoastRequest](#hoguera.platform.greenspace.api.v1.CoastRequest) <br /> Response: [CoastResponse](#hoguera.platform.greenspace.api.v1.CoastRequest) | <para></para> |
| `GetLocation` <br /><br /> Request: [LocationRequest](#hoguera.platform.greenspace.api.v1.LocationRequest) <br /> Response: [LocationResponse](#hoguera.platform.greenspace.api.v1.LocationRequest) | <para></para> |
| `GetAnimals` <br /><br /> Request: [AnimalsRequest](#hoguera.platform.greenspace.api.v1.AnimalsRequest) <br /> Response: [Animal](#hoguera.platform.greenspace.api.v1.AnimalsRequest) | <para>GetAnimals returns the animals that are in danger in the coast as a stream.</para> |
| `GetCoast` <br /><br /> Request: [CoastRequest](#hoguera.platform.greenspace.api.v1.CoastRequest) <br /> Response: [CoastResponse](#hoguera.platform.greenspace.api.v1.CoastRequest) | <para>GetCoast returns the nearest coast to the user location.</para> |
| `GetLocation` <br /><br /> Request: [LocationRequest](#hoguera.platform.greenspace.api.v1.LocationRequest) <br /> Response: [LocationResponse](#hoguera.platform.greenspace.api.v1.LocationRequest) | <para>GetLocation returns the location of the user.</para> |
| `GetV1` <br /><br /> Request: [.google.protobuf.Empty](#google.protobuf.Empty) <br /> Response: [V1Response](#google.protobuf.Empty) | <para>GetV1 is the BFF endpoint. It returns the location of the user, the nearest coast and the animals in danger.</para> |

<!-- end services -->
<!-- end files -->
Expand All @@ -64,7 +55,7 @@ Internal service
<a name="hoguera.platform.greenspace.api.v1.Animal"/>

### Animal
Animals
Animals the animals that are in danger in the coast.


#### Fields
Expand All @@ -81,7 +72,7 @@ Animals
<a name="hoguera.platform.greenspace.api.v1.AnimalsRequest"/>

### AnimalsRequest
*Description comment will be shown here (markdown supported)*
AnimalsRequest the user location is required to get the nearest animals living in the coast.


#### Fields
Expand All @@ -96,7 +87,7 @@ Animals
<a name="hoguera.platform.greenspace.api.v1.CoastRequest"/>

### CoastRequest
*Description comment will be shown here (markdown supported)*
CoastRequest the user location is required to get the nearest coast.


#### Fields
Expand All @@ -111,25 +102,25 @@ Animals
<a name="hoguera.platform.greenspace.api.v1.CoastResponse"/>

### CoastResponse
*Description comment will be shown here (markdown supported)*
CoastResponse the nearest coast to the user location.


#### Fields

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| name | [string](#string) | | <para></para> |
| condition | [Condition](#hoguera.platform.greenspace.api.v1.Condition) | | <para></para> |
| temperature | [float](#float) | | <para></para> |
| distance | [double](#double) | | <para></para> |
| name | [string](#string) | | <para>The name of the coast. e.g. "Playa de la Concha"</para> |
| condition | [Condition](#hoguera.platform.greenspace.api.v1.Condition) | | <para>The condition of the water. e.g. "GOOD"</para> |
| temperature | [float](#float) | | <para>The temperature of the water in Celsius. e.g. 20</para> |
| distance | [double](#double) | | <para>The distance in kilometers to the coast. e.g. 4.1</para> |




<a name="hoguera.platform.greenspace.api.v1.LocationRequest"/>

### LocationRequest
*Description comment will be shown here (markdown supported)*
LocationRequest the IP of the user is required to get the location.


#### Fields
Expand All @@ -151,17 +142,19 @@ Location

| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| longitude | [int32](#int32) | | <para></para> |
| latitude | [int32](#int32) | | <para></para> |
| name | [string](#string) | | <para></para> |
| longitude | [float](#float) | | <para></para> |
| latitude | [float](#float) | | <para></para> |
| name | [string](#string) | | <para>The name of the location. e.g. "San Sebastian"</para> |




<a name="hoguera.platform.greenspace.api.v1.V1Response"/>

### V1Response
BFF
V1Response the response of the V1 endpoint. It contains the location of the user, the nearest coast and the animals
in danger. It serves as a wrapper for the other responses. It is used to avoid multiple requests to the API and
follow the BFF pattern.


#### Fields
Expand All @@ -181,7 +174,7 @@ BFF
<a name="hoguera.platform.greenspace.api.v1.Condition"/>

### Condition
Coast
Condition, the condition of the water. In house algorithm to define the condition.


<details>
Expand Down