Operation Imports

You can import operation definitions from your API schema and render them in your Docusaurus Docs. You'll need to create an .mdx file and import the React Component. Read more here about MDX in Docusaurus.

Import Operation Model in Docs

The pointer prop is passed on to Redoc.

Note that / is escaped as ~1.

import ApiOperation from '@theme/ApiOperation';

<ApiOperation pointer="#/paths/~1pet/post" />;

Results

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Import Operation Model (with example) in Docs

import ApiOperation from '@theme/ApiOperation';

<ApiOperation example pointer="#/paths/~1pet/post" />;

Results

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Importing Operation Model with multiple OpenAPI schemas

If you have multiple APIs loaded with redocusaurus, then it is recommended to add ids to the config so that you can refer them when loading operation models.

docusaurus.config.js
const config = {
  presets: [
    '@docusaurus/preset-classic',
    [
      'redocusaurus',
      {
        specs: [
          {
            id: 'using-single-yaml',
            spec: 'openapi/single-file/openapi.yaml',
            route: '/examples/using-single-yaml/',
          },
          {
            id: 'using-remote-url',
            spec: 'https://redocly.github.io/redoc/openapi.yaml',
            route: '/examples/using-remote-url/',
          },
        ],
        theme: {
          /**
           * Highlight color for docs
           */
          primaryColor: '#1890ff',
          /**
           * Options to pass to redoc
           * @see https://github.com/redocly/redoc#redoc-options-object
           */
          options: { disableSearch: true },
        },
      },
    ],
  ],
  title: 'Redocusaurus',
};

import ApiOperation from '@theme/ApiOperation';

<ApiOperation id="using-single-yaml" pointer="#/paths/~1pet/post" />
<ApiOperation id="using-remote-url" pointer="#/paths/~1pet/post" />

Results

For ID `id="using-single-yaml"`

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

For ID `id="using-remote-url"`

Add a new pet to the store

Add new pet to the store inventory.

Authorizations:

petstore_auth

cookie Parameters

cookieParam

required

integer <int64>

Some cookie

header Parameters

Accept-Language

string

Default: en-AU

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US

Request Body schema:
application/json
required

Pet object that needs to be added to the store

	object Categories this pet belongs to
name required	string The name given to a pet
photoUrls required	Array of strings <url> <= 20 items [ items <url > ] The list of URL to a cute photos featuring pet
friend	object Recursive
	Array of objects (Tag) non-empty Tags attached to the pet
status	string Enum: "available" "pending" "sold" Pet status in the store
petType	string Type of a pet cat
huntingSkill required	string Default: "lazy" Enum: "clueless" "lazy" "adventurous" "aggressive" The measured skill for hunting

Responses

Request samples

Payload
C#
PHP

Content type

application/json

Example

cat

{"category": {"name": "string",
"sub": {"prop1": "string"
}
},
"name": "Guru",
"photoUrls": ["string"
],
"friend": { },
"tags": [{"name": "string"
}
],
"status": "available",
"petType": "cat",
"huntingSkill": "adventurous"
}

Import Operation Model in Docs

Results​

Add a new pet to the store

Authorizations:

cookie Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Responses

Request samples

Import Operation Model (with example) in Docs​

Results​

Add a new pet to the store

Authorizations:

cookie Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Responses

Request samples

Importing Operation Model with multiple OpenAPI schemas​

Results​

For ID id="using-single-yaml"​

Add a new pet to the store

Authorizations:

cookie Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Responses

Request samples

For ID id="using-remote-url"​

Add a new pet to the store

Authorizations:

cookie Parameters

header Parameters

Request Body schema: application/jsonapplication/xmlapplication/jsonrequired

Responses

Request samples

Results

Request Body schema:
application/json
required

Import Operation Model (with example) in Docs

Results

Request Body schema:
application/json
required

Importing Operation Model with multiple OpenAPI schemas

Results

For ID `id="using-single-yaml"`

Request Body schema:
application/json
required

For ID `id="using-remote-url"`

Request Body schema:
application/json
required