{{ServiceDescription}}
{{NamedCredentialName}}
OpenApi3
Complete
{
"openapi": "3.0.0",
"info": {
"title": "{{ServiceTitle}}",
"version": "1.0.0",
"description": "{{ServiceDescription}}"
},
"servers": [
{
"url": "{{BaseUrl}}"
}
],
"paths": {
"/{{resourcePath}}": {
"get": {
"operationId": "get{{ResourceName}}",
"summary": "Get {{ResourceName}}",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/{{ResourceName}}"
}
}
}
}
}
},
"post": {
"operationId": "create{{ResourceName}}",
"summary": "Create {{ResourceName}}",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/{{ResourceName}}Input"
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/{{ResourceName}}"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"{{ResourceName}}": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"createdAt": {
"type": "string",
"format": "date-time"
}
}
},
"{{ResourceName}}Input": {
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string"
}
}
}
}
}
}
true
get{{ResourceName}}
true
create{{ResourceName}}