-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathurltomarkdown.openapi.json
executable file
·149 lines (149 loc) · 4.35 KB
/
urltomarkdown.openapi.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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
{
"openapi": "3.1.0",
"info": {
"title": "urltomarkdown - OpenAPI 3.1",
"description": "Provides a web service that accesses a requested web page and outputs a markdown version.\n\nSource code for the web service is available at [the urltomarkdown repository](https://github.com/macsplit/urltomarkdown)",
"version": "1.0"
},
"servers": [
{
"url": "https://urltomarkdown.herokuapp.com"
}
],
"paths": {
"/": {
"get": {
"summary": "Convert a web page",
"description": "Outputs a markdown version of the page.",
"parameters": [
{
"in": "query",
"name": "url",
"description": "The address of the web page.",
"schema": {
"type": "string"
},
"required": true
},
{
"in": "query",
"name": "title",
"description": "Whether to prepend an inline title. This parameter expects the values \"true\" or \"false\" only.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "links",
"description": "Whether to mark up links. This parameter expects the values \"true\" or \"false\" only.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "clean",
"description": "Whether to clean before conversion. This parameter expects the values \"true\" or \"false\" only.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful operation.",
"content": {
"text/markdown": {
"schema": false
}
},
"headers": {
"X-Title": {
"description": "The title of the web page.",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Could not access or convert web page."
}
}
},
"post": {
"summary": "Convert a web page with HTML supplied",
"description": "Outputs a markdown version of the page.",
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"type": "object",
"required": [ "html" ],
"properties": {
"url": {
"type": "string",
"description": "The original URL of the web page."
},
"html": {
"type": "string",
"description": "The HTML source of the web page."
}
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "title",
"description": "Whether to prepend an inline title. This parameter expects the values \"true\" or \"false\" only.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "links",
"description": "Whether to mark up links. This parameter expects the values \"true\" or \"false\" only.",
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "clean",
"description": "Whether to clean before conversion. This parameter expects the values \"true\" or \"false\" only.",
"schema": {
"type": "boolean"
}
}
],
"responses": {
"200": {
"description": "Successful operation.",
"content": {
"text/markdown": {
"schema": false
}
},
"headers": {
"X-Title": {
"description": "The title of the web page.",
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Could not convert web page."
}
}
}
}
}
}