// DOCUMENTATION
API Designer
Create and edit operations, request schemas, responses, examples and mock variants.
Operation basics
Manual API editing must be enabled for the workspace, and your role must allow edits. Source-managed workspaces can be read-only while mocks remain editable. Every operation starts with an HTTP method and path. Add a stable operation ID and summary so documentation and generated code remain understandable.
POST /payments
operationId: createPaymentRequest inputs
Define path, query and header parameters separately. Add a request body schema and example when the operation accepts structured JSON.
- Mark required parameters explicitly.
- Keep examples valid for the schema.
- Do not place credentials into examples.
Responses and validation
Describe success and failure statuses with headers, bodies and examples. The validation panel highlights incomplete or inconsistent operation configuration before it becomes shared context.
- Include common 4xx cases.
- Use the correct content type.
- Give each response a practical description.