UsageExample
A single usage example showing how to call a publisher's API
Properties
| Property | Type | Required | Description |
|---|---|---|---|
curl |
string,null | No | Full curl command example |
description |
string,null | No | Description of what this example demonstrates |
title |
string,null | No | Short title for the example (e.g., "Create a collection") |
View JSON Schema
{
"type": "object",
"description": "A single usage example showing how to call a publisher's API",
"properties": {
"curl": {
"type": [
"string",
"null"
],
"description": "Full curl command example"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of what this example demonstrates"
},
"title": {
"type": [
"string",
"null"
],
"description": "Short title for the example (e.g., \"Create a collection\")"
}
}
}