Skip to content

Commit b7a15b7

Browse files
committed
Merge branch 'swift-docs' of https://github.com/fern-api/docs into swift-docs
2 parents d50c054 + 326b50d commit b7a15b7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+695
-387
lines changed

fern/apis/fai/definition/chat.yml

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,34 @@ service:
1919
name: ChatCompletionRequest
2020
body:
2121
properties:
22-
model: optional<string>
23-
system_prompt: optional<string>
24-
messages: list<ChatTurn>
22+
model:
23+
type: LanguageModel
24+
docs: The model to use for the chat completion.
25+
system_prompt:
26+
type: optional<string>
27+
docs: The system prompt to use for the chat completion.
28+
messages:
29+
type: list<ChatTurn>
30+
docs: The messages to use for the chat completion.
2531
response: ChatCompletionResponse
2632
errors:
2733
- commons.BadRequestError
2834
- commons.InternalError
2935

3036
types:
3137
ChatCompletionResponse:
32-
type: list<ChatTurn>
38+
properties:
39+
turns: list<ChatTurn>
40+
citations: list<string>
3341

3442
ChatTurn:
3543
properties:
3644
role: string
3745
content: string
46+
47+
LanguageModel:
48+
enum:
49+
- name: claude_4
50+
value: claude-4-sonnet-20250514
51+
- name: command_a
52+
value: command-a-03-2025

fern/products/cli-api-reference/cli-changelog/2025-04-09.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33

44

55
## 0.57.19
6-
**`(fix):`** Fix an issue in the OpenAPI parser where array references were not being properly resolved. The parser now correctly resolves references
6+
**`(fix):`** Fix an issue in the OpenAPI parser where array references were not being properly resolved. The parser now correctly resolves references
77
within array schemas, ensuring that arrays of referenced types are properly handled throughout the API definition.
88

99

1010
## 0.57.18
11-
**`(fix):`** Improve the ReadMe migrator to respect the original navigation structure when creating the file hierarchy. Previously, nested navigation groups were
11+
**`(fix):`** Improve the ReadMe migrator to respect the original navigation structure when creating the file hierarchy. Previously, nested navigation groups were
1212
flattened, but now the file structure will mirror the navigation hierarchy, preserving the original organization of documentation.
1313

1414

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## 0.57.24
2-
**`(fix):`** Fix an issue in the OpenAPI importer where discriminated unions with literal discriminant values in the variants would render the discriminant property twice.
2+
**`(fix):`** Fix an issue in the OpenAPI importer where discriminated unions with literal discriminant values in the variants would render the discriminant property twice.
33
The importer now correctly checks if union variants contain the discriminant property as a literal value and handles them appropriately.
44

55

fern/products/cli-api-reference/cli-changelog/2025-04-21.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ Single element type arrays will resolve to the single element in the example.
66

77

88
## 0.57.33
9-
**`(feat):`** Improve OpenRPC response example generation by wrapping example payloads in JSON-RPC 2.0 format with metadata
9+
**`(feat):`** Improve OpenRPC response example generation by wrapping example payloads in JSON-RPC 2.0 format with metadata
1010
(jsonrpc version and request id). This ensures generated examples match the actual JSON-RPC response format.
1111

1212

1313
## 0.57.32
14-
**`(feat):`** Improve server handling in OpenAPI imports by exploding servers with enum variables into multiple servers,
15-
one for each enum value. For example, a server with URL "https://{region}.example.com" where region
14+
**`(feat):`** Improve server handling in OpenAPI imports by exploding servers with enum variables into multiple servers,
15+
one for each enum value. For example, a server with URL "https://{region}.example.com" where region
1616
is an enum ["us", "eu"] will be exploded into two servers: "https://us.example.com" and "https://eu.example.com".
1717

1818

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## 0.57.35
2-
**`(feat):`** Improve OpenAPI response handling for 204 status codes by respecting schema definitions.
3-
When a 204 (No Content) response includes a schema, the importer now properly processes
4-
and preserves this schema information, ensuring accurate API documentation and SDK generation
2+
**`(feat):`** Improve OpenAPI response handling for 204 status codes by respecting schema definitions.
3+
When a 204 (No Content) response includes a schema, the importer now properly processes
4+
and preserves this schema information, ensuring accurate API documentation and SDK generation
55
even for endpoints that don't return content in successful responses.
66

77

fern/products/cli-api-reference/cli-changelog/2025-04-24.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ multiple API Definitions that have overlapping schema names or operation names.
88

99

1010
## 0.57.37
11-
**`(feat):`** Improve OpenRPC request example generation by not wrapping request payloads in JSON-RPC 2.0 format.
12-
This ensures generated request examples match the expected format for the API's method parameters
11+
**`(feat):`** Improve OpenRPC request example generation by not wrapping request payloads in JSON-RPC 2.0 format.
12+
This ensures generated request examples match the expected format for the API's method parameters
1313
without the additional JSON-RPC envelope.
1414

1515

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## 0.58.2
2-
**`(feat):`** Enhance example generation to consider default values when generating examples for primitive types.
3-
When a string primitive type has a default value specified, the example generator now uses this
4-
default value instead of a generic example. This produces more realistic and contextually
2+
**`(feat):`** Enhance example generation to consider default values when generating examples for primitive types.
3+
When a string primitive type has a default value specified, the example generator now uses this
4+
default value instead of a generic example. This produces more realistic and contextually
55
appropriate examples in generated SDKs and documentation.
66

77

fern/products/cli-api-reference/cli-changelog/2025-04-27.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
## 0.58.3
2-
**`(feat):`** Enhance OpenAPI security scheme handling in the parser to support both global and endpoint-level security requirements.
3-
The parser now properly converts security schemes from OpenAPI's `securitySchemes` component into appropriate authentication
4-
headers, supporting bearer tokens, basic auth, and custom API key headers. Global security requirements defined at the
5-
document level are applied to all endpoints, while endpoint-specific security requirements override or supplement the
2+
**`(feat):`** Enhance OpenAPI security scheme handling in the parser to support both global and endpoint-level security requirements.
3+
The parser now properly converts security schemes from OpenAPI's `securitySchemes` component into appropriate authentication
4+
headers, supporting bearer tokens, basic auth, and custom API key headers. Global security requirements defined at the
5+
document level are applied to all endpoints, while endpoint-specific security requirements override or supplement the
66
global configuration, ensuring accurate authentication representation in generated SDKs.
77

88

fern/products/cli-api-reference/cli-changelog/2025-04-29.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44

55
## 0.59.1
6-
**`(feat):`** Enhance OpenAPI -> IR parser to better handle inlined oneOf schemas. The parser now uses the schema ID when
6+
**`(feat):`** Enhance OpenAPI -> IR parser to better handle inlined oneOf schemas. The parser now uses the schema ID when
77
generating names for oneOf variants, resulting in more predictable and consistent type names in the generated SDKs.
88

99

@@ -13,8 +13,8 @@ This command is in-development; changes are expected.
1313

1414

1515
## 0.58.6
16-
**`(feat):`** Add support for schema conversion in OpenRPC importer. The importer now properly converts schemas defined in the
17-
OpenRPC document's components section into Fern types, enabling full type definitions for request and response
16+
**`(feat):`** Add support for schema conversion in OpenRPC importer. The importer now properly converts schemas defined in the
17+
OpenRPC document's components section into Fern types, enabling full type definitions for request and response
1818
objects. This enhancement allows for more complete and accurate SDK generation from OpenRPC specifications.
1919

2020

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## 0.59.4
2-
**`(fix):`** Enhance OpenAPI -> IR conversion to properly handle default values in schemas. The converter now correctly extracts
3-
and preserves default values from OpenAPI schemas, ensuring they are properly represented in the generated SDKs.
2+
**`(fix):`** Enhance OpenAPI -> IR conversion to properly handle default values in schemas. The converter now correctly extracts
3+
and preserves default values from OpenAPI schemas, ensuring they are properly represented in the generated SDKs.
44
This improvement allows API providers to specify meaningful defaults that will be respected in client implementations.
55

66

77
## 0.59.3
8-
**`(fix):`** Improve OpenRPC importer to generate more unique schema IDs for request parameters by combining method name,
9-
"Param" keyword, and parameter name. This prevents naming conflicts when different methods have parameters
8+
**`(fix):`** Improve OpenRPC importer to generate more unique schema IDs for request parameters by combining method name,
9+
"Param" keyword, and parameter name. This prevents naming conflicts when different methods have parameters
1010
with the same name, resulting in more reliable and consistent type generation in the SDKs.
1111

1212

0 commit comments

Comments
 (0)