Skip to content

chore: Update OpenAPI specs #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions fern/apis/beta/changelog/2025-01-28.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@

## New Endpoints

### Atoms
- Added [`GET /atoms.get`](/beta/api-reference/atoms/get) and [`POST /atoms.get`](/beta/api-reference/atoms/get-post) endpoints as a way to retrieve generic object information

### Stage Diagrams
- Added new endpoints for managing stage diagrams:
- [`POST /stage-diagrams.create`](/beta/api-reference/customization/stage-diagrams-create)
- [`GET /stage-diagrams.get`](/beta/api-reference/customization/stage-diagrams-get) and [`POST /stage-diagrams.get`](/beta/api-reference/customization/stage-diagrams-get-post)
- [`GET /stage-diagrams.list`](/beta/api-reference/customization/stage-diagrams-list) and [`POST /stage-diagrams.list`](/beta/api-reference/customization/stage-diagrams-list-post)
- [`POST /stage-diagrams.update`](/beta/api-reference/customization/stage-diagrams-update)

## Modified Endpoints

### Conversations
- Added support for date filtering in conversations endpoints:
- [`GET /conversations.list`](/beta/api-reference/conversations/list)
- [`POST /conversations.list`](/beta/api-reference/conversations/list-post)
- [`GET /conversations.export`](/beta/api-reference/conversations/export)
- [`POST /conversations.export`](/beta/api-reference/conversations/export-post)

- Added new properties to conversation objects:
- `custom_fields`
- `custom_schema_fragments`
- `stock_schema_fragment`
- `subtype`

### Incidents
- Added `custom_fields` support to incidents endpoints:
- [`GET /incidents.group`](/beta/api-reference/operate/incidents-group)
- [`POST /incidents.group`](/beta/api-reference/operate/incidents-group-post)
- [`GET /incidents.list`](/beta/api-reference/operate/incidents-list)
- [`POST /incidents.list`](/beta/api-reference/operate/incidents-list-post)

### Snap-ins
- Added `is_expired` property to keyring objects in [`GET /snap-ins.resources`](/beta/api-reference/snap-ins/resources) and [`POST /snap-ins.resources`](/beta/api-reference/snap-ins/resources-post) responses

### Schema Changes
The following schema changes affect multiple endpoints:

- Added `translated_values` property to enum field descriptors
- Added `translated_values` property to enum list field descriptors
- These changes affect endpoints that work with schemas, including:
- Content template endpoints
- Schema management endpoints
- Survey endpoints
- Timeline entry endpoints
- Webhook event endpoints

### Webhook Events
- Added `old_conversation` property to conversation delete/update events
- Added `old_sla_tracker` property to SLA tracker update events
Loading
Loading