diff --git a/fern/products/sdks/reference/generators-yml-reference.mdx b/fern/products/sdks/reference/generators-yml-reference.mdx index 8da129a35..a345e0789 100644 --- a/fern/products/sdks/reference/generators-yml-reference.mdx +++ b/fern/products/sdks/reference/generators-yml-reference.mdx @@ -59,12 +59,12 @@ groups: ## auth-schemes Configures authentication methods for your API. - + ## api - + Defines the API specification (OpenAPI, AsyncAPI, etc.) and how to parse it. @@ -97,19 +97,19 @@ api: staging: "https://api.staging.com" ``` - + List of API specifications or Conjure configuration. - + Authentication configuration for the API. - + Default headers to include with API requests. - + Environment configurations for different deployment targets. @@ -135,87 +135,87 @@ api: max-depth: 2 ``` - + Path to the OpenAPI specification file. - + URL of the API definition origin for polling updates. - + Path to OpenAPI overrides file. - + Namespace for the specification. - + OpenAPI-specific generation settings. - + Whether to use the titles of schemas within an OpenAPI definition as the names of types within Fern. - + Whether to include path parameters within the generated in-lined request. - + Whether to prefer undiscriminated unions with literals. - + Whether to only include schemas referenced by endpoints in the generated SDK (tree-shaking). - + Preserves nullable schemas in API definition settings. When false, nullable schemas are treated as optional. - + Enables parsing deep object query parameters. - + Enables exploring readonly schemas in OpenAPI specifications. - + Enables respecting forward compatible enums in OpenAPI specifications. - + Enables using the `bytes` type for binary responses. Defaults to file stream. - + The default encoding of form parameters. Options: `form`, `json`. - + Configure what `additionalProperties` should default to when not explicitly defined on a schema. - + If true, convert strings with format date to strings. If false, convert to dates. - + If true, preserve oneOf structures with a single schema. If false, unwrap them. - + Endpoints to include in the generated SDK (e.g., "POST /users"). - + Controls the maximum depth for which optional properties will have examples generated. A depth of 0 means no optional properties will have examples. - + Controls the maximum depth for which optional properties will have examples generated in responses. @@ -234,35 +234,35 @@ api: respect-nullable-schemas: true ``` - + Path to the AsyncAPI specification file. - + URL of the API definition origin for polling updates. - + Path to AsyncAPI overrides file. - + Namespace for the specification. - + AsyncAPI-specific generation settings. - + What version of message naming to use for AsyncAPI messages. Options: `v1`, `v2`. - + Whether to use the titles of schemas within an AsyncAPI definition as the names of types within Fern. - + Preserves nullable schemas in API definition settings. When false, nullable schemas are treated as optional. @@ -277,37 +277,37 @@ api: local-generation: true ``` - + Protocol Buffers configuration. - + Path to the target `.proto` file (e.g., `proto/user/v1/user.proto`). - + Path to the `.proto` directory root (e.g., `proto`). - + Path to the overrides configuration. - + Whether to compile `.proto` files locally. Defaults to remote generation. #### OpenRPC - + Path to the OpenRPC specification file. - + Path to OpenRPC overrides file. - + Namespace for the specification. @@ -319,7 +319,7 @@ api: conjure: "./conjure-api.yml" ``` - + Path to Conjure specification file. @@ -334,19 +334,19 @@ whitelabel: token: "ghp_xxxxxxxxxxxx" ``` - + - + - + - + - + ## metadata @@ -362,19 +362,19 @@ metadata: email: "jane@example.com" ``` - + - + - + - + - + ## readme @@ -401,31 +401,31 @@ readme: path: "/users" ``` - + - + - + - + - + - + - + - + - + ## default-group @@ -435,7 +435,7 @@ Which group to use when none is specified. default-group: "production" ``` - + ## groups @@ -489,243 +489,243 @@ groups: - name: "john-doe" ``` - + - + - + - + - + - + ### Generator Configuration - + - + - + - + - + - + - + - + - + - + - + - + ### Output Locations #### NPM Output - + - + - + - + #### Maven Output - + - + - + - + - + - + - + - + - + #### PyPI Output - + - + - + - + - + - + - + - + - + - + #### NuGet Output - + - + - + - + #### RubyGems Output - + - + - + - + #### Postman Output - + - + - + - + #### Local File System Output - + - + ### GitHub Configuration - + - + - + - + - + - + - + - + ### Generator Metadata - + - + - + - + - + ### Snippets Configuration - + ### API Settings Override - + - + ## reviewers @@ -741,17 +741,17 @@ reviewers: - name: "jane-smith" ``` - + - + - + - + - + \ No newline at end of file