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.

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

🐛 style: improve documentation #16

Merged
merged 1 commit into from
Sep 28, 2023
Merged
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions api/docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Basic usage examples of the contractus API

**@Obs**: To run locally, the right host to put in the <> is the host that will retrieve after running `make ip`

# Endpoints

## `/upload`
Expand Down Expand Up @@ -30,7 +32,7 @@ Obs: If the affilate's name is "JONATHAN SILVA," it should be input as `?name=JO
Request:

```bash
curl -X -i 'GET' \
curl -i -X 'GET' \
'http://<>:8080/balance/affiliate?name=<>' \
-H 'accept: application/json'
```
Expand Down Expand Up @@ -58,7 +60,7 @@ Obs: If the producer's name is "JONATHAN SILVA," it should be input as `?name=JO
Request:

```bash
curl -X -i 'GET' \
curl -i -X 'GET' \
'http://<>:8080/balance/producer?name=<>' \
-H 'accept: application/json'
```
Expand Down