Skip to content

Commit

Permalink
Merge pull request #9 from jplacht/doc-routes
Browse files Browse the repository at this point in the history
Add sites and storage available routes to documentation
  • Loading branch information
jplacht authored Nov 6, 2023
2 parents b154b13 + 1728e2e commit 3d9410f
Showing 1 changed file with 31 additions and 17 deletions.
48 changes: 31 additions & 17 deletions docs/routes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,10 @@

FIO Wrapper includes the most commonly used FIO REST API endpoints.

## Planet

- `GET` /planet/{Planet}
- `GET` /planet/allplanets
- `GET` /planet/allplanets/full
- `GET` /planet/sites/{Planet}
- `POST` /planet/search

## Material
- `GET` /material/{MaterialTicker}
- `GET` /material/allmaterials
- `GET` /material/category/{CategoryName}

## Building
- `GET` /building/{BuildingTicker}
- `GET` /building/allbuildings

## Recipes
- `GET` /recipes/{Ticker}
- `GET` /recipes/allrecipes

## Exchange
- `GET` /exchange/{ExchangeTicker}
- `GET` /exchange/all
Expand All @@ -37,3 +20,34 @@ FIO Wrapper includes the most commonly used FIO REST API endpoints.
- `GET` /localmarket/shipping/destination/{Planet}
- `GET` /localmarket/company/{Company}

## Material
- `GET` /material/{MaterialTicker}
- `GET` /material/allmaterials
- `GET` /material/category/{CategoryName}

## Planet

- `GET` /planet/{Planet}
- `GET` /planet/allplanets
- `GET` /planet/allplanets/full
- `GET` /planet/sites/{Planet}
- `POST` /planet/search

## Recipes
- `GET` /recipes/{Ticker}
- `GET` /recipes/allrecipes

## Sites

- `GET` /sites/{UserName}
- `GET` /sites/planets/{UserName}
- `GET` /sites/{UserName}/{Planet}
- `GET` /sites/warehouses/{UserName}

## Storage

- `GET` /storage/{UserName}
- `GET` /storage/planets/{UserName}
- `GET` /storage/{UserName}/{StorageDescription}


0 comments on commit 3d9410f

Please sign in to comment.