-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnotetaker-api.paw.json
134 lines (134 loc) · 4.02 KB
/
notetaker-api.paw.json
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
{
"swagger": "2.0",
"info": {
"title": "notetaker-api.paw",
"version": "v0.0.0"
},
"host": "v5lonzrode.execute-api.ap-south-1.amazonaws.com",
"schemes": [
"https"
],
"basePath": "/notes",
"paths": {
"/": {
"post": {
"summary": "create a note",
"description": "API route to create a note. Requires title and description.",
"operationId": "35375b1b-9cfc-4b47-bbfd-f19364617ffc",
"consumes": [
"application/json"
],
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"default": "{\"title\":\"the ninth note\",\"description\":\"some data about the note\"}"
},
"in": "body",
"name": "body"
}
],
"responses": {
"default": {
"description": "no response description was provided for this operation"
}
}
},
"get": {
"summary": "list all notes",
"description": "API route to list all notes. Paginatable route that supports cursor based pagination and limits number of notes listed based on the cursor and limit query params",
"operationId": "915ec98f-675b-4358-b7e6-2fd4be4bf011",
"parameters": [
{
"type": "string",
"default": "",
"name": "cursor",
"required": false,
"in": "query"
}
],
"responses": {
"default": {
"description": "no response description was provided for this operation"
}
}
}
},
"/{noteId}": {
"get": {
"summary": "get a note",
"description": "API route to get a note. Returns noteId, title, description and meta timestamps.",
"operationId": "1dff298a-b1f0-416b-9111-d4e2984d2c4a",
"responses": {
"default": {
"description": "no response description was provided for this operation"
}
},
"parameters": [
{
"type": "string",
"default": "01HX97YSVTSPJ23K9A9XPXT1KQ",
"name": "noteId",
"description": "The noteId whose data needs to be returned",
"required": true,
"in": "path"
}
]
},
"put": {
"summary": "update a note",
"description": "API route to update a note's title and/or description based on the noteId. Returns the updated note data.",
"operationId": "5df822cc-e712-40f4-b556-ddc9685676d7",
"consumes": [
"application/json"
],
"parameters": [
{
"required": false,
"schema": {
"type": "string",
"default": "{\"title\":\"ninth updated title\",\"description\":\"another description\"}"
},
"in": "body",
"name": "body"
},
{
"type": "string",
"default": "01HX97YSVTSPJ23K9A9XPXT1KQ",
"name": "noteId",
"description": "The noteId whose data needs to be returned",
"required": true,
"in": "path"
}
],
"responses": {
"default": {
"description": "no response description was provided for this operation"
}
}
},
"delete": {
"summary": "delete a note",
"description": "API route to delete a note based on the noteId. Returns the deleted note data.",
"operationId": "f8ccfdec-b589-4a07-a2e6-b8f8cb66aff2",
"responses": {
"default": {
"description": "no response description was provided for this operation"
}
},
"parameters": [
{
"type": "string",
"default": "01HX8VX8GBEARPZDJRKATZY9AF",
"name": "noteId",
"description": "The noteId whose data needs to be returned",
"required": true,
"in": "path"
}
]
}
}
},
"tags": []
}