Skip to content

chore: add inline documentation to public API methods and schema types#1

Open
fern-api[bot] wants to merge 4 commits into
mainfrom
fern-bot/2026-06-25_21-11-04_679
Open

chore: add inline documentation to public API methods and schema types#1
fern-api[bot] wants to merge 4 commits into
mainfrom
fern-bot/2026-06-25_21-11-04_679

Conversation

@fern-api

@fern-api fern-api Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

1.0.0 → 1.0.1

Add Swift doc comments to all public client methods across every resource
client (Analytics, Assistants, Calls, Campaigns, Eval, Files, Insight)
and to several schema/request types. No public API signatures, types, or
behaviors were changed — only documentation strings were added or
improved.

Key changes:

  • Added /// doc comments with parameter descriptions to all resource
    client methods (list, create, get, delete, update, run, preview, etc.)
  • Added struct-level doc comments to BackoffPlan, CallHookCustomerSpeechTimeout,
    CustomerSpeechTimeoutOptions, MonitorPlan, CreateFileDto, and
    InsightRunDto
  • Improved existing inline field comments in BackoffPlan,
    CustomerSpeechTimeoutOptions, MonitorPlan, and UpdateAssistantDto
    for clarity
  • Added .fern/replay.lock, .fern/replay.yml, and .gitattributes to
    .fernignore

🌿 Generated with Fern

@fern-api
fern-api Bot force-pushed the fern-bot/2026-06-25_21-11-04_679 branch 6 times, most recently from a6d3f97 to 148a566 Compare July 2, 2026 18:47
@fern-api
fern-api Bot force-pushed the fern-bot/2026-06-25_21-11-04_679 branch 3 times, most recently from 0c95ff1 to 7f3581e Compare July 8, 2026 00:29
@fern-api
fern-api Bot force-pushed the fern-bot/2026-06-25_21-11-04_679 branch 7 times, most recently from c6c9bb1 to 56119cf Compare July 18, 2026 00:21
@fern-api fern-api Bot changed the title chore: update .fernignore with additional ignored files chore: add inline documentation to public API methods and schema types Jul 20, 2026
@fern-api
fern-api Bot force-pushed the fern-bot/2026-06-25_21-11-04_679 branch 3 times, most recently from 01c8bc5 to bdbe8b5 Compare July 21, 2026 02:24
fern-api Bot added 4 commits July 22, 2026 16:33
Generated by Fern
CLI Version: unknown
Generators:
  - fernapi/fern-swift-sdk: 0.31.0
…ods and schema types

Add Swift doc comments to all public client methods across every resource
client (Analytics, Assistants, Calls, Campaigns, Eval, Files, Insight)
and to several schema/request types. No public API signatures, types, or
behaviors were changed — only documentation strings were added or
improved.

Key changes:
- Added `///` doc comments with parameter descriptions to all resource
  client methods (list, create, get, delete, update, run, preview, etc.)
- Added struct-level doc comments to `BackoffPlan`, `CallHookCustomerSpeechTimeout`,
  `CustomerSpeechTimeoutOptions`, `MonitorPlan`, `CreateFileDto`, and
  `InsightRunDto`
- Improved existing inline field comments in `BackoffPlan`,
  `CustomerSpeechTimeoutOptions`, `MonitorPlan`, and `UpdateAssistantDto`
  for clarity
- Added `.fern/replay.lock`, `.fern/replay.yml`, and `.gitattributes` to
  `.fernignore`

🌿 Generated with Fern
Add Swift doc comments to all public client methods across every resource
client (Analytics, Assistants, Calls, Campaigns, Eval, Files, Insight)
and to several schema/request types. No public API signatures, types, or
behaviors were changed — only documentation strings were added or
improved.

Key changes:
- Added `///` doc comments with parameter descriptions to all resource
  client methods (list, create, get, delete, update, run, preview, etc.)
- Added struct-level doc comments to `BackoffPlan`, `CallHookCustomerSpeechTimeout`,
  `CustomerSpeechTimeoutOptions`, `MonitorPlan`, `CreateFileDto`, and
  `InsightRunDto`
- Improved existing inline field comments in `BackoffPlan`,
  `CustomerSpeechTimeoutOptions`, `MonitorPlan`, and `UpdateAssistantDto`
  for clarity
- Added `.fern/replay.lock`, `.fern/replay.yml`, and `.gitattributes` to
  `.fernignore`

🌿 Generated with Fern
@fern-api
fern-api Bot force-pushed the fern-bot/2026-06-25_21-11-04_679 branch from bdbe8b5 to 9759c8c Compare July 22, 2026 16:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants