Skip to content

Commit 5f6bb36

Browse files
authored
Merge pull request #1 from caseylee-TC/update-openapi-spec
updated OpenAPI spec
2 parents 3548b03 + 912b6ff commit 5f6bb36

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

‎openapi.yml‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,19 @@ info:
55
description: Our free API tells you when the sun rises and sets anywhere on Earth, plus **twilight**, **golden hour**, **solar position** and **moon data**. All you need is a **latitude** and **longitude**; you make a simple GET request and get the answer as JSON.<br /><br />Time come in the local timezone of the place, and you can ask for a single day or up to a whole year in one request.<br /><br />The API is **free to use**; no sign up or API key required.
66
termsOfService: https://sunrise-sunset.org/
77
version: 'Version 2'
8+
license:
9+
name: MIT
810
#The server object to include the URLs to the production server of the API.
911
servers:
1012
- url: https://api.sunrise-sunset.org
1113
description: Version 2
14+
#The API is free to use and requires no API key or authentication.
15+
security: []
1216
#The `paths` object holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL to query the API. There is only one operation for this API.
1317
paths:
1418
/v2:
1519
get:
20+
summary: Get sunrise, sunset, twilight, and moon data for a location
1621
description: Returns when the sun rises and sets anywhere on Earth, plus twilight, golden hour, solar position and moon data.
1722
operationId: getSunriseSunset
1823
parameters:
@@ -342,8 +347,7 @@ components:
342347
error: too many requests too quickly
343348
message: "slow down"
344349
docs: https://sunrise-sunset.org/api#rate-limits
345-
#The externalDocs object is for a single link of external documentation or reference that might be relevant to the API. Here is it used as attribution as required by the [API](https://sunrise-sunset.org/api)
350+
#The externalDocs object is for a single link of external documentation or reference that might be relevant to the API. Here it is used as attribution as required by the [API](https://sunrise-sunset.org/api)
346351
externalDocs:
347352
description: https://sunrise-sunset.org/api
348-
url: https://sunrise-sunset.org/api
349-
353+
url: https://sunrise-sunset.org/api

0 commit comments

Comments
 (0)