Skip to content

Commit

Permalink
Merge pull request #16 from perebaj/api_docs
Browse files Browse the repository at this point in the history
🐛 style: improve documentation
  • Loading branch information
perebaj authored Sep 28, 2023
2 parents b46c169 + b762f92 commit ffe169e
Showing 1 changed file with 4 additions and 2 deletions.
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

0 comments on commit ffe169e

Please sign in to comment.