Endpoints Reference
Complete reference for REST API endpoint definitions including HTTP methods, paths, request bodies, and responses.
Endpoints define the operations available in your REST API. Each endpoint specifies an HTTP method, path, and the expected request and response formats.
Endpoint Properties
| Property | Type | Description |
|---|---|---|
| id | string | Unique endpoint identifier |
| method | enum | HTTP method (GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD) |
| path | string | URL path with optional parameters (e.g., /users/{id}) |
| summary | string | Short description for documentation |
| description | string | Detailed description (rich text supported) |
| tags | array | Tags for grouping related endpoints |
| operationId | string | Unique operation identifier for code generation |
| deprecated | boolean | Deprecation flag |
HTTP Methods
| Method | Purpose | Idempotent |
|---|---|---|
| GET | Retrieve resources | Yes |
| POST | Create resources | No |
| PUT | Replace resources entirely | Yes |
| PATCH | Partial update of resources | No |
| DELETE | Remove resources | Yes |
| OPTIONS | Describe available options | Yes |
| HEAD | Retrieve headers only (no body) | Yes |
Path Parameters
Request Body
| Property | Description |
|---|---|
| required | Whether the body is required for the request |
| description | Description of the request body contents |
| content | Content type and schema definition |