-
Notifications
You must be signed in to change notification settings - Fork 16
/
surfreport.orrenprunckun.com.yaml
149 lines (149 loc) · 4.65 KB
/
surfreport.orrenprunckun.com.yaml
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
openapi: 3.0.1
info:
title: Aus Surf Report
description: Get today's surf report for any break throughout Australia!
version: 'v1'
servers:
- url: https://surfreport.orrenprunckun.com/
paths:
/:
get:
operationId: getLocation
summary: Get surf report by location
description: Get today's surf report for a specific location.
parameters:
- name: South Australia
in: query
description: South Australia
required: true
schema:
type: string
enum:
- 'South Central Coast'
- 'Central Coast'
- 'South Mid Coast'
- 'Mid Coast'
- 'Metro Waters'
- 'Spencer Gulf Coast'
- 'Lower West Coast'
- 'Upper West Coast'
- 'Far West Coast'
- name: Victoria
in: query
description: Victoria
required: true
schema:
type: string
enum:
- 'East Gippsland Coast'
- 'Central Gippsland Coast'
- 'Central Coast'
- 'West Coast'
- name: New South Wales
in: query
description: New South Wales
required: true
schema:
type: string
enum:
- 'Eden Coast'
- 'Batemans Coast'
- 'Illawarra Coast'
- 'Sydney Coast'
- 'Hunter Coast'
- 'Macquarie Coast'
- 'Coffs Coast'
- 'Northern Rivers'
- name: Queensland
in: query
description: Queensland
required: true
schema:
type: string
enum:
- 'South East Gulf Of Carpentaria'
- 'North East Gulf Of Carpentaria'
- 'Torres Strait Coastal Waters'
- 'Peninsula Coast'
- 'Cooktown Coast'
- 'Cairns Coast'
- 'Townsville Coast'
- 'Mackay Coast'
- 'Capricornia Coast'
- 'Fraser Island Coast'
- 'Sunshine Coast'
- 'Gold Coast'
- name: Northern Territory
in: query
description: Northern Territory
required: true
schema:
type: string
enum:
- 'South East Gulf Of Carpentaria'
- 'Roper Groote Coast'
- 'Gove Peninsula Coast'
- 'Arafura Coast'
- 'North Tiwi Coast'
- 'Van Diemen Gulf'
- 'Beagle Bonaparte Gulf'
- 'North Kimberley Coast'
- name: Western Australia
in: query
description: Western Australia
required: true
schema:
type: string
enum:
- 'Eucla Coast'
- 'Esperance Coast'
- 'Albany Coast'
- 'Leeuwin Coast'
- 'Bunbury Geographe Coast'
- 'Perth Coast'
- 'Perth Local Waters'
- 'Lancelin Coast'
- 'Geraldton Coast'
- 'Gascoyne Coast'
- 'Ningaloo Coast'
- 'Pilbara West Coast'
- 'Pilbara East Coast'
- 'West Kimberley Coast'
- 'North Kimberley Coast'
- name: Tasmania
in: query
description: Tasmania
required: true
schema:
type: string
enum:
- 'Far Northwest Coast'
- 'Central North Coast'
- 'East Of Flinders Island'
- 'Banks Strait And Franklin'
- 'Upper East Coast'
- 'Lower East Coast'
- 'South East Coast'
- 'South West Coast'
- 'Central West Coast'
post:
operationId: SendResponse
summary: Send surf report request with custom header
description: Send a surf report request to the server with a custom HTTP header based on the user input location.
parameters:
- name: location
in: query
description: Location for which to send the surf report request.
required: true
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
message:
type: string