Skip to content

Commit 5f13e37

Browse files
author
Cassidy Schaufele
authored
DOP-2658: Add preview OpenAPI page (#85)
* DOP-2658: Add preview OpenAPI page * DOP-2658: Add noindex to robots for preview page.
1 parent 9ee2259 commit 5f13e37

File tree

2 files changed

+145
-0
lines changed

2 files changed

+145
-0
lines changed

‎source/openapi/loremipsum.json‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
{
2+
"swagger":"2.0",
3+
"info":{
4+
"version":"1.0.0",
5+
"title":"Lorem Ipsum",
6+
"description":"Basic Lorem Ipsum spec file, for MongoDB Open API styling preview purposes.",
7+
"termsOfService":"http://swagger.io/terms/",
8+
"contact":{
9+
"name":"MongoDB Docs Platform Team"
10+
},
11+
"license":{
12+
"name":"MIT"
13+
}
14+
},
15+
"host":"www.mongodb.com",
16+
"basePath":"/api",
17+
"schemes":[
18+
"http"
19+
],
20+
"consumes":[
21+
"application/json"
22+
],
23+
"produces":[
24+
"application/json"
25+
],
26+
"paths":{
27+
"/lorem":{
28+
"get":{
29+
"description":"Lorem ipsum dolor sit amet",
30+
"operationId":"loremIpsum",
31+
"produces":[
32+
"application/json",
33+
"application/xml",
34+
"text/xml",
35+
"text/html"
36+
],
37+
"parameters":[
38+
{
39+
"name":"tags",
40+
"in":"query",
41+
"description":"tags to filter by",
42+
"required":false,
43+
"type":"array",
44+
"items":{
45+
"type":"string"
46+
},
47+
"collectionFormat":"csv"
48+
},
49+
{
50+
"name":"limit",
51+
"in":"query",
52+
"description":"maximum number of results to return",
53+
"required":false,
54+
"type":"integer",
55+
"format":"int32"
56+
}
57+
],
58+
"responses":{
59+
"200":{
60+
"description":"loremIpsum",
61+
"schema":{
62+
"type":"array",
63+
"items":{
64+
"$ref":"#/definitions/Lorem"
65+
}
66+
}
67+
},
68+
"default":{
69+
"description":"loremIpsum",
70+
"schema":{
71+
"$ref":"#/definitions/ErrorModel"
72+
}
73+
}
74+
}
75+
}
76+
}
77+
},
78+
"definitions":{
79+
"Lorem":{
80+
"type":"object",
81+
"allOf":[
82+
{
83+
"$ref":"#/definitions/Ipsum"
84+
},
85+
{
86+
"required":[
87+
"id"
88+
],
89+
"properties":{
90+
"id":{
91+
"type":"integer",
92+
"format":"int64"
93+
}
94+
}
95+
}
96+
]
97+
},
98+
"Ipsum":{
99+
"type":"object",
100+
"required":[
101+
"name"
102+
],
103+
"properties":{
104+
"name":{
105+
"type":"string"
106+
},
107+
"tag":{
108+
"type":"string"
109+
}
110+
}
111+
},
112+
"ErrorModel":{
113+
"type":"object",
114+
"required":[
115+
"code",
116+
"message"
117+
],
118+
"properties":{
119+
"code":{
120+
"type":"integer",
121+
"format":"int32"
122+
},
123+
"message":{
124+
"type":"string"
125+
}
126+
}
127+
}
128+
}
129+
}

‎source/openapi/preview.txt‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
:orphan:
2+
3+
.. meta::
4+
:robots: noindex
5+
6+
:template: openapi
7+
:title: OpenAPI Styling Preview
8+
9+
.. default-domain:: mongodb
10+
11+
.. banner::
12+
:variant: info
13+
14+
This page is intended for previewing OpenAPI spec files with the styling of MongoDB's documentation. The contents may not reflect actual endpoints or services.
15+
16+
.. openapi:: /openapi/loremipsum.json

0 commit comments

Comments
 (0)