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
21If 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"Request Body
Responses
Document updated successfully
"date-time"Size of the document in bytes