98 lines
2.5 KiB
Markdown
98 lines
2.5 KiB
Markdown
---
|
|
name: inline-hooks-routes
|
|
description: Handle 9 OpenAPI operation(s) under /api/v1/inlineHooks for the inlineHooks route group.
|
|
---
|
|
|
|
# inlineHooks API Routes
|
|
|
|
Handle 9 OpenAPI operation(s) under /api/v1/inlineHooks for the inlineHooks route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_inline_hooks
|
|
|
|
- Operation ID: `list_inline_hooks`
|
|
- Route: `GET /api/v1/inlineHooks`
|
|
- Mode: READ
|
|
- Summary: List all inline hooks
|
|
- Parameters:
|
|
- `type` in `query`
|
|
|
|
### create_inline_hook
|
|
|
|
- Operation ID: `create_inline_hook`
|
|
- Route: `POST /api/v1/inlineHooks`
|
|
- Mode: WRITE
|
|
- Summary: Create an inline hook
|
|
- Body: JSON request body accepted.
|
|
|
|
### get_inline_hook
|
|
|
|
- Operation ID: `get_inline_hook`
|
|
- Route: `GET /api/v1/inlineHooks/{inlineHookId}`
|
|
- Mode: READ
|
|
- Summary: Retrieve an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|
|
|
|
### update_inline_hook
|
|
|
|
- Operation ID: `update_inline_hook`
|
|
- Route: `POST /api/v1/inlineHooks/{inlineHookId}`
|
|
- Mode: WRITE
|
|
- Summary: Update an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### replace_inline_hook
|
|
|
|
- Operation ID: `replace_inline_hook`
|
|
- Route: `PUT /api/v1/inlineHooks/{inlineHookId}`
|
|
- Mode: WRITE
|
|
- Summary: Replace an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_inline_hook
|
|
|
|
- Operation ID: `delete_inline_hook`
|
|
- Route: `DELETE /api/v1/inlineHooks/{inlineHookId}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|
|
|
|
### execute_inline_hook
|
|
|
|
- Operation ID: `execute_inline_hook`
|
|
- Route: `POST /api/v1/inlineHooks/{inlineHookId}/execute`
|
|
- Mode: WRITE
|
|
- Summary: Execute an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### activate_inline_hook
|
|
|
|
- Operation ID: `activate_inline_hook`
|
|
- Route: `POST /api/v1/inlineHooks/{inlineHookId}/lifecycle/activate`
|
|
- Mode: WRITE
|
|
- Summary: Activate an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|
|
|
|
### deactivate_inline_hook
|
|
|
|
- Operation ID: `deactivate_inline_hook`
|
|
- Route: `POST /api/v1/inlineHooks/{inlineHookId}/lifecycle/deactivate`
|
|
- Mode: WRITE
|
|
- Summary: Deactivate an inline hook
|
|
- Parameters:
|
|
- `inlineHookId` in `path` required
|