forked from openai/plugins-quickstart
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
201 lines (201 loc) · 6.4 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
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
openapi: 3.0.0
info:
title: Medium API
version: "1.0"
servers:
- url: https://medium-gpt-43dd525e084a.herokuapp.com
paths:
/me:
get:
operationId: getAuthenticatedUserDetails
summary: Returns details of the user who has granted permission to the application.
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
description: A unique identifier for the user.
username:
type: string
description: The user’s username on Medium.
name:
type: string
description: The user’s name on Medium.
url:
type: string
description: The URL to the user’s profile on Medium.
imageUrl:
type: string
description: The URL to the user’s avatar on Medium.
'401':
description: Unauthorized
/users/{authorId}/posts:
post:
operationId: createUserPost
summary: Creates a post on the authenticated user’s profile.
parameters:
- name: authorId
in: path
required: true
description: The user id of the authenticated user.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: The title of the post.
maxLength: 100
contentFormat:
type: string
enum: [html, markdown]
description: The format of the "content" field.
content:
type: string
description: The body of the post, in a valid, semantic, HTML fragment, or Markdown.
tags:
type: array
items:
type: string
maxLength: 25
canonicalUrl:
type: string
publishStatus:
type: string
enum: [public, draft, unlisted]
license:
type: string
enum: [all-rights-reserved, cc-40-by, cc-40-by-sa, cc-40-by-nd, cc-40-by-nc, cc-40-by-nc-nd, cc-40-by-nc-sa, cc-40-zero, public-domain]
notifyFollowers:
type: boolean
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
title:
type: string
authorId:
type: string
tags:
type: array
items:
type: string
url:
type: string
canonicalUrl:
type: string
publishStatus:
type: string
publishedAt:
type: integer
format: int64
license:
type: string
licenseUrl:
type: string
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
/publications/{publicationId}/posts:
post:
operationId: createPublicationPost
summary: Creates a post under a publication.
parameters:
- name: publicationId
in: path
required: true
description: The id of the publication the post is being created under.
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: The title of the post.
maxLength: 100
contentFormat:
type: string
enum: [html, markdown]
content:
type: string
description: The body of the post, in a valid, semantic, HTML fragment, or Markdown.
tags:
type: array
items:
type: string
maxLength: 25
publishStatus:
type: string
enum: [public, draft, unlisted]
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
publicationId:
type: string
title:
type: string
authorId:
type: string
tags:
type: array
items:
type: string
url:
type: string
canonicalUrl:
type: string
publishStatus:
type: string
publishedAt:
type: integer
format: int64
license:
type: string
licenseUrl:
type: string
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden