This repository has been archived by the owner on Jun 1, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.yaml
87 lines (87 loc) · 2.4 KB
/
api.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
openapi: 3.0.0
info:
title: Simple Search API
version: 1.0.0
servers:
- url: http://localhost:8080
description: Local Developerment Server
paths:
/search:
get:
summary: Search (fulltext, timerange and term filter) with limit an offset
parameters:
- in: query
name: q
description: a search string for fulltext search
schema:
type: string
- in: query
name: tag
description: one or more tags for result filtering
schema:
type: array
items:
type: string
- in: query
name: range
schema:
type: string
enum:
- PAST_HOUR
- PAST_DAY
- PAST_WEEK
- in: query
name: limit
schema:
type: integer
default: 10
- in: query
name: offset
schema:
type: integer
default: 0
responses:
'200':
description: the search result
content:
application/json:
schema:
type: object
properties:
limit:
type: integer
offest:
type: integer
numOfResults:
type: integer
docs:
type: array
items:
type: object
properties:
id:
type: string
title:
type: string
date:
type: string
tags:
type: array
items:
type: string
rating:
type: number
format: double
scoring:
type: number
format: double
tags:
description: the tag facets
type: array
items:
type: object
properties:
value:
type: string
count:
type: integer