-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
101 lines (96 loc) · 2.11 KB
/
openapi.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
openapi: 3.0.2
info:
title: Property Listing API
version: 1.0.0
description: API for searching and retrieving property listings.
paths:
/:
get:
summary: Home page
responses:
'200':
description: Successful response
content:
text/html:
schema:
type: string
/listings/:
post:
summary: Get property listings
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/ListingRequest'
responses:
'200':
description: Successful response
content:
text/html:
schema:
type: string
/listing/{property_id}:
get:
summary: Get property details
parameters:
- name: property_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Successful response
content:
text/html:
schema:
type: string
'404':
description: Property not found
post:
summary: Get property price estimate
parameters:
- name: property_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/PriceEstimateRequest'
responses:
'200':
description: Successful response
content:
text/html:
schema:
type: string
'404':
description: Property not found
components:
schemas:
ListingRequest:
required:
- suburb_name
- bedrooms
- bathrooms
- carspaces
properties:
suburb_name:
type: string
bedrooms:
type: integer
bathrooms:
type: integer
carspaces:
type: integer
honey:
type: string
PriceEstimateRequest:
required:
- price_estimate
properties:
price_estimate:
type: string