Skip to content

Commit

Permalink
fix: tab indentation code
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Lin committed Jan 23, 2023
1 parent b0e8fad commit e60ef70
Show file tree
Hide file tree
Showing 29 changed files with 9,092 additions and 96 deletions.
15 changes: 7 additions & 8 deletions docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,12 @@ It is highly recommended that you use a tool like [`nvm`](https://github.com/nvm
1. Navigate to root folder of the project after installing Node.js
2. Run the following in sequence, which only needs to be done once:

```bash
npm install
npm prepare
```
```bash
npm install
npm prepare
```

3. To preview and for every time afterwards:

```bash
npm run start
```
```bash
npm run start
```
495 changes: 492 additions & 3 deletions docs/test-api/add-pet.api.mdx

Large diffs are not rendered by default.

536 changes: 533 additions & 3 deletions docs/test-api/create-user.api.mdx

Large diffs are not rendered by default.

548 changes: 547 additions & 1 deletion docs/test-api/create-users-with-array-input.api.mdx

Large diffs are not rendered by default.

548 changes: 547 additions & 1 deletion docs/test-api/create-users-with-list-input.api.mdx

Large diffs are not rendered by default.

124 changes: 121 additions & 3 deletions docs/test-api/delete-order.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,127 @@ description: "For valid response try integer IDs with value < 1000. Anything abo
sidebar_label: "Delete purchase order by ID"
hide_title: true
hide_table_of_contents: true
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":"apiteam@swagger.io","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"}}
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": "apiteam@swagger.io",
"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",
},
}
sidebar_class_name: "delete api-method"
info_path: docs/test-api/swagger-petstore-yaml
custom_edit_url: null
Expand All @@ -22,8 +142,6 @@ import TabItem from "@theme/TabItem";

## Delete purchase order by ID



For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"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><TabItem label={"400"} value={"400"}><div>
Expand Down
Loading

0 comments on commit e60ef70

Please sign in to comment.