You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/test-api/delete-order.api.mdx
+121-3
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,127 @@ description: "For valid response try integer IDs with value < 1000. Anything abo
5
5
sidebar_label: "Delete purchase order by ID"
6
6
hide_title: true
7
7
hide_table_of_contents: true
8
-
api: {"tags":["store"],"description":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors","operationId":"deleteOrder","parameters":[{"name":"orderId","in":"path","description":"ID of the order that needs to be deleted","required":true,"schema":{"type":"string","minimum":1}}],"responses":{"400":{"description":"Invalid ID supplied"},"404":{"description":"Order not found"}},"method":"delete","path":"/store/order/{orderId}","servers":[{"url":"https://petstore.swagger.io/v2","description":"Default server"},{"url":"https://petstore.swagger.io/sandbox","description":"Sandbox server"},{"url":"http://127.0.0.1:4010","description":"Prism Mock API (local)"}],"securitySchemes":{"petstore_auth":{"description":"Get access to data while protecting your account credentials.\nOAuth2 is also a safer and more secure way to give you access.\n","type":"oauth2","flows":{"implicit":{"authorizationUrl":"http://petstore.swagger.io/api/oauth/dialog","scopes":{"write:pets":"modify pets in your account","read:pets":"read your pets"}}}},"api_key":{"description":"For this sample, you can use the api key `special-key` to test the authorization filters.\n","type":"apiKey","name":"api_key","in":"header"}},"info":{"description":"This is a sample server Petstore server.\nYou can find out more about Swagger at\n[http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).\nFor this sample, you can use the api key `special-key` to test the authorization filters.\n\n## Introduction\nThis API is documented in **OpenAPI format** and is based on\n[Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.\nIt was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)\ntool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard\nOpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).\n\n## OpenAPI Specification\nThis API is documented in **OpenAPI format** and is based on\n[Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.\nIt was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)\ntool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard\nOpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).\n\n## Cross-Origin Resource Sharing\nThis API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).\nAnd that allows cross-domain communication from the browser.\nAll responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.\n\n## Authentication\n\nPetstore offers two forms of authentication:\n - API Key\n - OAuth2\nOAuth2 - an open protocol to allow secure authorization in a simple\nand standard method from web, mobile and desktop applications.\n","version":"2.0.0","title":"Swagger Petstore YAML","termsOfService":"http://swagger.io/terms/","contact":{"name":"API Support","email":"[email protected]","url":"https://github.com/Redocly/redoc"},"x-logo":{"url":"https://redocly.github.io/redoc/petstore-logo.png","altText":"Petstore logo"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"postman":{"name":"Delete purchase order by ID","description":{"content":"For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors","type":"text/plain"},"url":{"path":["store","order",":orderId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ID of the order that needs to be deleted","type":"text/plain"},"type":"any","value":"","key":"orderId"}]},"method":"DELETE"}}
8
+
api:
9
+
{
10
+
"tags": ["store"],
11
+
"description": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
12
+
"operationId": "deleteOrder",
13
+
"parameters":
14
+
[
15
+
{
16
+
"name": "orderId",
17
+
"in": "path",
18
+
"description": "ID of the order that needs to be deleted",
19
+
"required": true,
20
+
"schema": { "type": "string", "minimum": 1 },
21
+
},
22
+
],
23
+
"responses":
24
+
{
25
+
"400": { "description": "Invalid ID supplied" },
26
+
"404": { "description": "Order not found" },
27
+
},
28
+
"method": "delete",
29
+
"path": "/store/order/{orderId}",
30
+
"servers":
31
+
[
32
+
{
33
+
"url": "https://petstore.swagger.io/v2",
34
+
"description": "Default server",
35
+
},
36
+
{
37
+
"url": "https://petstore.swagger.io/sandbox",
38
+
"description": "Sandbox server",
39
+
},
40
+
{
41
+
"url": "http://127.0.0.1:4010",
42
+
"description": "Prism Mock API (local)",
43
+
},
44
+
],
45
+
"securitySchemes":
46
+
{
47
+
"petstore_auth":
48
+
{
49
+
"description":
50
+
"Get access to data while protecting your account credentials.\nOAuth2 is also a safer and more secure way to give you access.\n",
"For this sample, you can use the api key `special-key` to test the authorization filters.\n",
69
+
"type": "apiKey",
70
+
"name": "api_key",
71
+
"in": "header",
72
+
},
73
+
},
74
+
"info":
75
+
{
76
+
"description":
77
+
"This is a sample server Petstore server.\nYou can find out more about Swagger at\n[http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/).\nFor this sample, you can use the api key `special-key` to test the authorization filters.\n\n## Introduction\nThis API is documented in **OpenAPI format** and is based on\n[Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.\nIt was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)\ntool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard\nOpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).\n\n## OpenAPI Specification\nThis API is documented in **OpenAPI format** and is based on\n[Petstore sample](http://petstore.swagger.io/) provided by [swagger.io](http://swagger.io) team.\nIt was **extended** to illustrate features of [generator-openapi-repo](https://github.com/Rebilly/generator-openapi-repo)\ntool and [ReDoc](https://github.com/Redocly/redoc) documentation. In addition to standard\nOpenAPI syntax we use a few [vendor extensions](https://github.com/Redocly/redoc/blob/master/docs/redoc-vendor-extensions.md).\n\n## Cross-Origin Resource Sharing\nThis API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).\nAnd that allows cross-domain communication from the browser.\nAll responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.\n\n## Authentication\n\nPetstore offers two forms of authentication:\n - API Key\n - OAuth2\nOAuth2 - an open protocol to allow secure authorization in a simple\nand standard method from web, mobile and desktop applications.\n",
"content": "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
104
+
"type": "text/plain",
105
+
},
106
+
"url":
107
+
{
108
+
"path": ["store", "order", ":orderId"],
109
+
"host": ["{{baseUrl}}"],
110
+
"query": [],
111
+
"variable":
112
+
[
113
+
{
114
+
"disabled": false,
115
+
"description":
116
+
{
117
+
"content": "(Required) ID of the order that needs to be deleted",
118
+
"type": "text/plain",
119
+
},
120
+
"type": "any",
121
+
"value": "",
122
+
"key": "orderId",
123
+
},
124
+
],
125
+
},
126
+
"method": "DELETE",
127
+
},
128
+
}
9
129
sidebar_class_name: "delete api-method"
10
130
info_path: docs/test-api/swagger-petstore-yaml
11
131
custom_edit_url: null
@@ -22,8 +142,6 @@ import TabItem from "@theme/TabItem";
22
142
23
143
## Delete purchase order by ID
24
144
25
-
26
-
27
145
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
28
146
29
147
<detailsstyle={{"marginBottom":"1rem"}}data-collapsed={false}open={true}><summarystyle={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItemclassName={"paramsItem"}param={{"name":"orderId","in":"path","description":"ID of the order that needs to be deleted","required":true,"schema":{"type":"string","minimum":1}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItemlabel={"400"}value={"400"}><div>
0 commit comments