Example of an OpenAPI document with different types of parameters.
Servers
List users
Returns a list of users with optional filtering.
Parameters
Header Parameters
API key for authentication
"api-key-123"Query Parameters
Filter users by name
"John"Filter users by age
2501201Maximum number of users to return
10110020Number of users to skip for pagination
000Responses
Successful response
Create a new user
Creates a new user with the provided information.
Parameters
Header Parameters
API key for authentication
"api-key-123"Unique request identifier for tracing
"123e4567-e89b-12d3-a456-426614174000""uuid"Query Parameters
If true, validates the request without creating the user
falseRegion for user creation
"us-east""us-west""eu-central""us-east"Request Body
User's full name
2100User's email address
"email"User's age in years
18120User's address information
User's preferences
Additional user metadata
Responses
User created successfully
The ID of the newly created user
"date-time"Get user information by ID
Returns information for a specific user.
Parameters
Header Parameters
A custom header for testing purposes
"custom-value"350"^[a-zA-Z0-9-]+$"Path Parameters
The ID of the user
"123"Query Parameters
The age of the user to filter
2501201Whether the user accepts cookies
trueWhether the user is subscribed to the newsletter
falseResponses
Successful response
Update document content
Updates an existing document with plain text content.
Parameters
Header Parameters
API key for authentication
"api-key-123"Unique transaction identifier for tracing
"123e4567-e89b-12d3-a456-426614174000""uuid"Path Parameters
The ID of the document to update
"doc-123"Query Parameters
Document version for concurrency control
11If true, completely overwrites the document instead of merging changes
falseFormat of the document content
"plain""markdown""html""plain"Tags to associate with the document
"important""draft"Additional JSON metadata for the document
{
"author": "Jane Doe",
"category": "report"
}Request Body
Responses
Document updated successfully
"date-time"Size of the document in bytes
Test deepObject parameter variants
Endpoint to test different variants of deepObject style parameters in query strings.
Parameters
Header Parameters
API key for authentication
"api-key-123"Query Parameters
Simple object with deepObject style and explode: true (default)
{
"name": "John Doe",
"age": 30,
"active": true
}Simple object with deepObject style and explode: false
{
"author": "Jane Doe",
"category": "report"
}Nested object with deepObject style (object within object)
{
"user": {
"name": "John",
"email": "john@example.com"
},
"settings": {
"theme": "dark",
"notifications": true
}
}Object containing arrays with deepObject style
{
"tags": [
"important",
"urgent"
],
"categories": [
"work",
"personal"
],
"ids": [
1,
2,
3
]
}Complex nested object with multiple levels and mixed types
{
"metadata": {
"author": {
"name": "Jane Doe",
"id": 123
},
"created": "2023-01-01",
"tags": [
"draft",
"review"
]
},
"config": {
"enabled": true,
"priority": 5
}
}Object with mixed data types (string, number, boolean, array)
{
"name": "Product",
"price": 99.99,
"inStock": true,
"discount": 0.15,
"features": [
"feature1",
"feature2"
],
"rating": 4.5
}Object with additionalProperties allowing dynamic keys
{
"customField1": "value1",
"customField2": "value2",
"dynamicKey": "dynamicValue"
}Responses
Successful response with parsed deepObject parameters
Test endpoint for named examples
Endpoint designed to test the named examples functionality with various parameter types and multiple named examples.
Parameters
Header Parameters
Environment header with named examples
"development""staging""production""development"Request type with boolean-like named examples
"async""sync""batch"Path Parameters
Resource ID path parameter with named examples
"user-12345""^[a-z0-9-]+$"Query Parameters
Status of the operation with multiple named examples
"pending""active""completed""cancelled""pending""active""completed""cancelled"Priority level with numeric named examples
115Filter object with named examples containing different structures
{
"field": "name",
"value": "John",
"operator": "equals"
}Tags array with different named examples
"important"Complex metadata object with nested named examples
{
"source": "api",
"version": 1
}Request Body
Responses
Successful response