๐Ÿ“ฆ rparrett / weather_dashboard

๐Ÿ“„ README.md ยท 72 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72# Rust API client for pirate_weather

Pirate Weather provides an open, free, and documented source of government weather data.


## Overview

This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [openapi-spec](https://openapis.org) from a remote server, you can easily generate an API client.

- API version: 2.9.0
- Package version: 2.9.0
- Generator version: 7.13.0
- Build package: `org.openapitools.codegen.languages.RustClientCodegen`

## Installation

Put the package under your project folder in a directory named `pirate_weather` and add the following to `Cargo.toml` under `[dependencies]`:

```
pirate_weather = { path = "./pirate_weather" }
```

## Documentation for API Endpoints

All URIs are relative to *https://api.pirateweather.net*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*WeatherApi* | [**weather**](docs/WeatherApi.md#weather) | **GET** /forecast/{api_key}/{lat_and_long_or_time} | Make a request to Pirate Weather


## Documentation For Models

 - [AlertsInner](docs/AlertsInner.md)
 - [Currently](docs/Currently.md)
 - [Daily](docs/Daily.md)
 - [DailyDataInner](docs/DailyDataInner.md)
 - [DayNight](docs/DayNight.md)
 - [DayNightDataInner](docs/DayNightDataInner.md)
 - [Flags](docs/Flags.md)
 - [FlagsSourceIdx](docs/FlagsSourceIdx.md)
 - [FlagsSourceIdxDwdMosmix](docs/FlagsSourceIdxDwdMosmix.md)
 - [FlagsSourceIdxDwdMosmixStations](docs/FlagsSourceIdxDwdMosmixStations.md)
 - [FlagsSourceIdxEcmwfIfs](docs/FlagsSourceIdxEcmwfIfs.md)
 - [FlagsSourceIdxEtopo](docs/FlagsSourceIdxEtopo.md)
 - [FlagsSourceIdxGfs](docs/FlagsSourceIdxGfs.md)
 - [FlagsSourceIdxHrrr](docs/FlagsSourceIdxHrrr.md)
 - [FlagsSourceIdxNbm](docs/FlagsSourceIdxNbm.md)
 - [FlagsSourceIdxRtmaRu](docs/FlagsSourceIdxRtmaRu.md)
 - [FlagsSourceTimes](docs/FlagsSourceTimes.md)
 - [Hourly](docs/Hourly.md)
 - [HourlyDataInner](docs/HourlyDataInner.md)
 - [Minutely](docs/Minutely.md)
 - [MinutelyDataInner](docs/MinutelyDataInner.md)
 - [Weather200Response](docs/Weather200Response.md)
 - [Weather400Response](docs/Weather400Response.md)
 - [Weather404Response](docs/Weather404Response.md)
 - [Weather500Response](docs/Weather500Response.md)
 - [Weather502Response](docs/Weather502Response.md)


To get access to the crate's generated documentation, use:

```
cargo doc --open
```

## Author

mail@pirateweather.net