Skip to content

Commit 391f425

Browse files
committed
reorganize auth sections and make more concise
1 parent 53858d2 commit 391f425

File tree

1 file changed

+6
-34
lines changed

1 file changed

+6
-34
lines changed

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

Lines changed: 6 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -890,13 +890,13 @@ groups:
890890
The path to the generated snippets file.
891891
</ParamField>
892892

893-
### API Settings Override
893+
### Override API Authentication Settings
894894

895895
Override authentication settings in your API spec using the `api` configuration.
896896
You can specify authentication schemes, reference existing auth configurations,
897897
and set additional API-specific settings.
898898

899-
#### String Reference
899+
#### Single Authentication Scheme
900900

901901
Reference a pre-defined authentication scheme by name.
902902

@@ -910,37 +910,13 @@ groups:
910910
auth: "bearer-token"
911911
```
912912

913-
<ParamField path="auth" type="string" required={false} toc={true}>
914-
The name of an authentication scheme defined in your API specification.
915-
</ParamField>
916-
917-
#### Scheme Reference
918-
919-
Reference a specific authentication scheme with optional documentation.
920-
921-
```yml {6-9}
922-
groups:
923-
ts-sdk:
924-
generators:
925-
- name: fernapi/fern-typescript-sdk
926-
...
927-
api:
928-
auth:
929-
scheme: "my-auth-scheme"
930-
docs: "Custom authentication method"
931-
```
932-
933-
<ParamField path="scheme" type="string" required={true} toc={true}>
934-
The name of the authentication scheme to use.
935-
</ParamField>
936-
937-
<ParamField path="docs" type="string" required={false} toc={true}>
938-
Documentation describing this authentication configuration.
913+
<ParamField path="auth" type="string | { scheme: string }" required={false} toc={true}>
914+
The authentication scheme to use. Can be either a string reference (`"bearer-token"`) or scheme object (`scheme: "bearer-token"`).
939915
</ParamField>
940916
941917
#### Multiple Authentication Options
942918
943-
Allow any of multiple authentication schemes to be used.
919+
Allow users to authenticate with any of several methods:
944920
945921
```yml {6-12}
946922
groups:
@@ -954,16 +930,12 @@ groups:
954930
- "api-key"
955931
- "bearer-token"
956932
- scheme: "oauth-flow"
957-
docs: "Supports multiple authentication methods"
958933
```
959934
960935
<ParamField path="any" type="list<string | { scheme: string }>" required={true} toc={true}>
961-
List of authentication schemes where any one can be used. Can include string references or scheme objects.
936+
A list of authentication schemes where users can choose any one method. Each item can be either a string reference (`"api-key"`) or scheme object (`scheme: "api-key"`).
962937
</ParamField>
963938

964-
<ParamField path="docs" type="string" required={false} toc={true}>
965-
Documentation describing this authentication configuration.
966-
</ParamField>
967939

968940
#### Custom Authentication Schemes
969941

0 commit comments

Comments
 (0)