Skip to content

Commit d1825b3

Browse files
committed
formatting fixes
1 parent 47dbc1b commit d1825b3

File tree

2 files changed

+13
-8
lines changed

2 files changed

+13
-8
lines changed

fern/products/sdks/guides/configure-global-headers.mdx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ If you'd like to see this feature, please upvote [this issue](https://github.com
7979

8080
For OpenAPI specifications, you can configure global headers in two ways:
8181

82-
### Method 1: OpenAPI Spec Extension
82+
#### Method 1: OpenAPI Spec Extension
8383

8484
Add global headers directly to your OpenAPI spec using the `x-fern-global-headers` extension to label additional headers as global or to alias the names of global headers:
8585

@@ -91,7 +91,7 @@ x-fern-global-headers:
9191
optional: true
9292
```
9393

94-
### Method 2: `generators.yml` Configuration
94+
#### Method 2: `generators.yml` Configuration
9595

9696
Alternatively, you can add headers to the `api` block in your `generators.yml` file:
9797

@@ -107,18 +107,19 @@ api:
107107
type: optional<string>
108108
```
109109

110-
For more information, see the [`generators.yml` reference documentation](/sdks/reference/generators-yml#apiheaders).
110+
For more information, see the [`generators.yml` reference documentation](/sdks/reference/generators-yml#headers).
111111

112-
#### Client con
112+
#### Client code
113113

114-
Both of the above configurations produces the same client code:
114+
Both of the above configurations produce the same client code:
115115

116116
```python
117117
import os
118118
119119
class Client:
120120
121-
def __init__(self, *, apiKey: str, userpoolId: typing.Optional[str])
121+
def __init__(self, *, apiKey: str,
122+
userpoolId: typing.Optional[str])
122123
```
123124

124125

fern/products/sdks/reference/generators-yml-reference.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,12 @@ api:
108108
- openapi: ./path/to/openapi
109109
headers:
110110
X-Version:
111-
name: version # The variable name to use in generated SDK code. If not specified, uses the header name.
112-
type: literal<"1234"> # The type of the header value for code generation (e.g., "string", "literal<'value'>", "number").
111+
# The variable name to use in generated SDK code.
112+
# If not specified, uses the header name.
113+
name: version
114+
# The type of the header value for code generation
115+
# (e.g., "string", "literal<'value'>", "number").
116+
type: literal<"1234">
113117
```
114118
</ParamField>
115119

0 commit comments

Comments
 (0)