From df9eb52d7395b856832bcce47901cd0b34a4f299 Mon Sep 17 00:00:00 2001 From: Viljami Date: Sun, 5 Nov 2023 15:49:53 +0100 Subject: [PATCH] Deploy website - based on 6b02906649f651b315c025a3c74abbdec7a0fbd8 --- 404.html | 12 ++++++------ assets/css/styles.951ae442.css | 1 - assets/css/styles.cd76c1f9.css | 1 + ...1df93b7f.43f06aed.js => 1df93b7f.c7282c54.js} | 2 +- assets/js/{main.86e6533d.js => main.317940ef.js} | 4 ++-- ....LICENSE.txt => main.317940ef.js.LICENSE.txt} | 0 ...main.3e61aada.js => runtime~main.f3de2909.js} | 2 +- blog/archive/index.html | 12 ++++++------ blog/first-blog-post/index.html | 12 ++++++------ blog/index.html | 12 ++++++------ blog/tags/index.html | 12 ++++++------ blog/tags/openapi/index.html | 12 ++++++------ docs/api-first/index.html | 12 ++++++------ docs/examples/boilerplate/index.html | 12 ++++++------ docs/examples/building-apis/index.html | 12 ++++++------ docs/examples/calling-apis/index.html | 12 ++++++------ docs/examples/index.html | 10 +++++----- docs/examples/tanstack-query/index.html | 12 ++++++------ .../index.html | 12 ++++++------ docs/index.html | 10 +++++----- docs/intro/index.html | 12 ++++++------ docs/openapi-backend/api/index.html | 12 ++++++------ docs/openapi-backend/examples/index.html | 12 ++++++------ docs/openapi-backend/index.html | 10 +++++----- docs/openapi-backend/intro/index.html | 12 ++++++------ docs/openapi-backend/mocking/index.html | 12 ++++++------ .../operation-handlers/index.html | 12 ++++++------ .../request-validation/index.html | 12 ++++++------ .../response-validation/index.html | 12 ++++++------ .../openapi-backend/security-handlers/index.html | 12 ++++++------ docs/openapi-backend/typescript/index.html | 12 ++++++------ docs/openapi-backend/versioning/index.html | 12 ++++++------ docs/openapi-client-axios/api/index.html | 12 ++++++------ docs/openapi-client-axios/bundling/index.html | 12 ++++++------ docs/openapi-client-axios/index.html | 10 +++++----- docs/openapi-client-axios/intro/index.html | 12 ++++++------ docs/openapi-client-axios/typegen/index.html | 12 ++++++------ docs/openapi-client-axios/usage/index.html | 12 ++++++------ docs/openapicmd/call/index.html | 12 ++++++------ docs/openapicmd/config/index.html | 12 ++++++------ .../generating-documentation/index.html | 12 ++++++------ docs/openapicmd/index.html | 10 +++++----- docs/openapicmd/intro/index.html | 12 ++++++------ docs/openapicmd/mock-server/index.html | 12 ++++++------ docs/openapicmd/typegen/index.html | 12 ++++++------ img/sponsors/fern_logo_tagline.png | Bin 0 -> 6224 bytes imprint/index.html | 12 ++++++------ index.html | 12 ++++++------ search-index-blog_posts_list.json | 2 +- search-index-default.json | 2 +- search-index-docs-default-current.json | 2 +- 51 files changed, 249 insertions(+), 249 deletions(-) delete mode 100644 assets/css/styles.951ae442.css create mode 100644 assets/css/styles.cd76c1f9.css rename assets/js/{1df93b7f.43f06aed.js => 1df93b7f.c7282c54.js} (91%) rename assets/js/{main.86e6533d.js => main.317940ef.js} (98%) rename assets/js/{main.86e6533d.js.LICENSE.txt => main.317940ef.js.LICENSE.txt} (100%) rename assets/js/{runtime~main.3e61aada.js => runtime~main.f3de2909.js} (56%) create mode 100644 img/sponsors/fern_logo_tagline.png diff --git a/404.html b/404.html index 740ab485..22c5eea5 100644 --- a/404.html +++ b/404.html @@ -9,13 +9,13 @@ - - - + + +
-
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- - + + \ No newline at end of file diff --git a/docs/openapicmd/call/index.html b/docs/openapicmd/call/index.html index f4b2ab47..668938b3 100644 --- a/docs/openapicmd/call/index.html +++ b/docs/openapicmd/call/index.html @@ -9,13 +9,13 @@ - - - + + +
-

Call API operations

info

The call command can be used to call APIs from the command line for testing or automation purposes e.g. in CI pipelines or shell scripts.

Use the call command to call operations in your API from the command line:

openapi call https://petstore3.swagger.io/api/v3/openapi.json

or with npx:

npx openapicmd call https://petstore3.swagger.io/api/v3/openapi.json

Interactive Mode

tip

In non-TTY environments openapicmd will not run in interactive mode. See how to pass parameters instead.

By default, openapicmd will act in interactive mode to guide with calling the API:

? select operation
❯ GET /pet/{petId} - Find pet by ID (getPetById)
POST /pet/{petId} - Updates a pet in the store with form data (updatePetWithForm)
DELETE /pet/{petId} - Deletes a pet (deletePet)
POST /pet/{petId}/uploadImage - uploads an image (uploadFile)
GET /store/inventory - Returns pet inventories by status (getInventory)
POST /store/order - Place an order for a pet (placeOrder)
GET /store/order/{orderId} - Find purchase order by ID (getOrderById)
(Move up and down to reveal more choices)
? select operation GET /pet/{petId} - Find pet by ID (getPetById)
petId: 1
? use security scheme
◯ api_key
◯ petstore_auth

Result:

GET /pet/1
{
"id": 1,
"name": "Dogs",
"photoUrls": [
"nulla mollit veniam ea"
],
"tags": [
{
"id": -21297897,
"name": "incididunt sed eiusmod"
}
],
"status": "pending"
}

Parameters

You can pass parameters directly as command line flags to skip interactive mode:

openapi call https://petstore3.swagger.io/api/v3/openapi.json -o updatePet -d '{"id": 1, "name":"Cats"}' -p petId=1 --security=none
  • operationId can be speficified with the -o or --operation
  • Path, query and header parameters can be passed with the -p or --param flag.
  • Request bodies can be passed with the -d or --data flag.
  • Raw headers can be passed with the -H or --header flag.

To gain more information about the request and response, you can use the -i or --include flag.

Authorization

The call command supports most security schemes defined in OpenAPI v3.

Setting Headers

You can directly set headers such as api keys or authorization using the -H or --header flag.

openapi call https://petstore3.swagger.io/api/v3/openapi.json -o getInventory -H 'authorization: Bearer token123'

Basic Auth

For basic auth, you can directly pass --username and --passsword

openapi call https://petstore3.swagger.io/api/v3/openapi.json -o getInventory --username admin --password secret123

Bearer Token

If your API defines a Bearer Token security scheme e.g. OAuth2, you can pass a token using the --token flag.

openapi call https://petstore3.swagger.io/api/v3/openapi.json -o getInventory --token=eyJhbGciOiJIUzI1....

API Key

If your API defines an API Key security scheme, you can directly pass the key / token using the --api-key flag.

openapi call https://petstore3.swagger.io/api/v3/openapi.json -o getInventory --api-key=secret123