diff --git a/fern/products/api-def/asyncapi-pages/channels/pubsub.mdx b/fern/products/api-def/asyncapi-pages/channels/pubsub.mdx index cd51ae39c..671948567 100644 --- a/fern/products/api-def/asyncapi-pages/channels/pubsub.mdx +++ b/fern/products/api-def/asyncapi-pages/channels/pubsub.mdx @@ -1,6 +1,6 @@ --- title: Publish/Subscribe Operations -subtitle: Document event-driven APIs with publish and subscribe operations +description: Define AsyncAPI publish/subscribe operations for event-driven APIs. Step-by-step tutorial with message examples and bi-directional channels. --- Operations in AsyncAPI are defined underneath the `operations` key, with channels defined under the `channels` key. Below is an example of defining publish and subscribe operations: diff --git a/fern/products/api-def/asyncapi-pages/extensions/examples.mdx b/fern/products/api-def/asyncapi-pages/extensions/examples.mdx index 0affa6767..22de7053b 100644 --- a/fern/products/api-def/asyncapi-pages/extensions/examples.mdx +++ b/fern/products/api-def/asyncapi-pages/extensions/examples.mdx @@ -1,6 +1,7 @@ --- title: Request + response examples -description: Provide additional examples for better SDK documentation using `x-fern-examples` extension +description: Add message examples to AsyncAPI specs with `x-fern-examples`. Improve SDK documentation with real-world payload examples. +og:title: AsyncAPI request + response examples --- Provide additional examples for better SDK documentation: diff --git a/fern/products/api-def/asyncapi-pages/extensions/server-name.mdx b/fern/products/api-def/asyncapi-pages/extensions/server-name.mdx index 085298ca1..e6807a3dd 100644 --- a/fern/products/api-def/asyncapi-pages/extensions/server-name.mdx +++ b/fern/products/api-def/asyncapi-pages/extensions/server-name.mdx @@ -1,6 +1,6 @@ --- title: Server names -description: Specify custom names for servers using `x-fern-server-name` extension +description: Configure custom server names in AsyncAPI specifications with `x-fern-server-name` extension. Set up production and staging server labels. --- Specify custom names for servers: diff --git a/fern/products/api-def/ferndef-pages/auth.mdx b/fern/products/api-def/ferndef-pages/auth.mdx index e3ec38870..880c61291 100644 --- a/fern/products/api-def/ferndef-pages/auth.mdx +++ b/fern/products/api-def/ferndef-pages/auth.mdx @@ -1,6 +1,6 @@ --- title: Authentication -subtitle: Model auth schemes such as bearer, basic, custom headers, and oauth. +description: Configure API authentication in Fern Definition. Set up bearer tokens, basic auth, custom headers, and OAuth for your API endpoints. --- Configuring authentication schemes happens in the `api.yml` file. All Fern-generated SDKs support both direct configuration and environment variables for authentication credentials. diff --git a/fern/products/api-def/ferndef-pages/overview.mdx b/fern/products/api-def/ferndef-pages/overview.mdx index c948510ae..d889254e1 100644 --- a/fern/products/api-def/ferndef-pages/overview.mdx +++ b/fern/products/api-def/ferndef-pages/overview.mdx @@ -1,6 +1,6 @@ --- title: What is a Fern Definition? -description: "A Fern Definition is a set of YAML files that describe your API." +description: Fern Definition is a YAML format for API specifications. Define your REST API endpoints, data models, and errors in one source of truth. --- A Fern Definition is a set of YAML files that are the single source of truth for your API. You check your Fern Definition into your repo, diff --git a/fern/products/api-def/grpc-pages/automation.mdx b/fern/products/api-def/grpc-pages/automation.mdx index a41723d7c..21fae422e 100644 --- a/fern/products/api-def/grpc-pages/automation.mdx +++ b/fern/products/api-def/grpc-pages/automation.mdx @@ -1,6 +1,6 @@ --- title: Sync your gRPC specification -subtitle: Automatically sync your Protocol Buffer changes to keep SDKs and docs up to date +description: Automate gRPC specification syncing with Fern. Set up GitHub Actions, CI/CD pipelines, and scheduled updates for Protocol Buffer files. --- Keeping your gRPC specifications in sync with your codebase is crucial for maintaining accurate SDKs and documentation. Fern provides several automation options to streamline this process. diff --git a/fern/products/api-def/grpc-pages/reference/generators-reference.mdx b/fern/products/api-def/grpc-pages/reference/generators-reference.mdx index 3181bc8a2..038bd46bd 100644 --- a/fern/products/api-def/grpc-pages/reference/generators-reference.mdx +++ b/fern/products/api-def/grpc-pages/reference/generators-reference.mdx @@ -1,6 +1,6 @@ --- title: gRPC generators.yml reference -description: Reference for configuring gRPC specifications in your generators.yml file +description: Complete gRPC generators.yml reference guide for Fern. Learn how to configure root, target, overrides, and local-generation settings. --- The `generators.yml` file serves two roles: it declares your gRPC specification location (in the `api.specs` section), and configures SDK generation (in the optional `groups` section). diff --git a/fern/products/api-def/openapi-pages/extensions/availability.mdx b/fern/products/api-def/openapi-pages/extensions/availability.mdx index 4069b17b1..d2ecb0c0d 100644 --- a/fern/products/api-def/openapi-pages/extensions/availability.mdx +++ b/fern/products/api-def/openapi-pages/extensions/availability.mdx @@ -1,6 +1,6 @@ --- title: Availability -description: Mark endpoint availability status using `x-fern-availability` extension +description: Mark API endpoint availability in OpenAPI with `x-fern-availability`. Set beta, deprecated, stable, etc. statuses for endpoints and sections. --- The `x-fern-availability` extension is used to mark the availability of an endpoint within your OpenAPI definition. The availability information propagates into the generated Fern Docs website as visual tags. diff --git a/fern/products/api-def/openapi-pages/extensions/base-path.mdx b/fern/products/api-def/openapi-pages/extensions/base-path.mdx index df950139c..2dfe66f27 100644 --- a/fern/products/api-def/openapi-pages/extensions/base-path.mdx +++ b/fern/products/api-def/openapi-pages/extensions/base-path.mdx @@ -1,12 +1,11 @@ --- title: Base path -description: Configure base path prepended to endpoints using `x-fern-base-path` extension +description: Configure base paths in OpenAPI with `x-fern-base-path`. Set up endpoint prefixes like /v1 for your API definitions with Fern. --- -## Base path -The `x-fern-base-path` extension is used to configure the base path prepended to every endpoint. +Use the `x-fern-base-path` extension to configure the base path prepended to every endpoint. -In the example below, we have configured the `/v1` base path so the full endpoint path is +The example below configures the `/v1` base path so the full endpoint path is `https://api.example.com/v1/users`. ```yaml title="Set the base path in openapi.yml" {1} diff --git a/fern/products/api-def/openapi-pages/extensions/enums.mdx b/fern/products/api-def/openapi-pages/extensions/enums.mdx index 05344d7a8..bac3046df 100644 --- a/fern/products/api-def/openapi-pages/extensions/enums.mdx +++ b/fern/products/api-def/openapi-pages/extensions/enums.mdx @@ -1,6 +1,6 @@ --- title: Enum descriptions and names -description: Add descriptions and custom names to enum values using `x-fern-enum` extension +description: Add descriptions to OpenAPI enum values with `x-fern-enum` extension. Customize enum names for cleaner SDK code and better documentation. --- OpenAPI doesn't natively support adding descriptions to enum values. To do this in Fern you can use the `x-fern-enum` diff --git a/fern/products/api-def/openapi-pages/extensions/examples.mdx b/fern/products/api-def/openapi-pages/extensions/examples.mdx index a124a4cf8..1ba1cc0dc 100644 --- a/fern/products/api-def/openapi-pages/extensions/examples.mdx +++ b/fern/products/api-def/openapi-pages/extensions/examples.mdx @@ -1,6 +1,7 @@ --- title: Request + response examples -description: Associate request and response examples using `x-fern-examples` extension +description: Configure OpenAPI request and response examples with x-fern-examples. Associate path parameters, query parameters, and responses in your API definition. +og:title: OpenAPI request + response examples --- diff --git a/fern/products/api-def/openapi-pages/extensions/server-names.mdx b/fern/products/api-def/openapi-pages/extensions/server-names.mdx index 561b8cb2a..970da1316 100644 --- a/fern/products/api-def/openapi-pages/extensions/server-names.mdx +++ b/fern/products/api-def/openapi-pages/extensions/server-names.mdx @@ -1,6 +1,6 @@ --- title: Server names -description: Name your servers using the `x-fern-server-name` extension +description: Learn how to use the `x-fern-server-name` extension to name servers in your OpenAPI specification for better SDK generation. --- The `x-fern-server-name` extension is used to name your servers. diff --git a/fern/products/api-def/openrpc-pages/extensions/examples.mdx b/fern/products/api-def/openrpc-pages/extensions/examples.mdx index aa6676337..3e7366f8f 100644 --- a/fern/products/api-def/openrpc-pages/extensions/examples.mdx +++ b/fern/products/api-def/openrpc-pages/extensions/examples.mdx @@ -1,6 +1,7 @@ --- title: Request + response examples -description: Provide additional examples for better SDK documentation using `x-fern-examples` extension +description: Add multiple request and response examples to OpenRPC methods with x-fern-examples. Improve your SDK docs with real-world use cases. +og:title: OpenRPC request + response examples --- Provide additional examples for better SDK documentation: diff --git a/fern/products/api-def/openrpc-pages/extensions/method-names.mdx b/fern/products/api-def/openrpc-pages/extensions/method-names.mdx index d9e0528dd..a8c6c2c27 100644 --- a/fern/products/api-def/openrpc-pages/extensions/method-names.mdx +++ b/fern/products/api-def/openrpc-pages/extensions/method-names.mdx @@ -1,6 +1,6 @@ --- title: SDK Method Names -subtitle: Use `x-fern-sdk-method-name` to customize SDK method names for JSON-RPC methods +description: Control SDK method names in OpenRPC specifications. Use `x-fern-sdk-method-name` to define intuitive, language-specific method names for your JSON-RPC API. --- By default, Fern generates SDK method names based on your OpenRPC method names. You can override this behavior using the `x-fern-sdk-method-name` extension. diff --git a/fern/products/api-def/openrpc-pages/extensions/overview.md b/fern/products/api-def/openrpc-pages/extensions/overview.md index 20eaccacb..5d319498b 100644 --- a/fern/products/api-def/openrpc-pages/extensions/overview.md +++ b/fern/products/api-def/openrpc-pages/extensions/overview.md @@ -1,6 +1,6 @@ --- title: Overview of OpenRPC extensions -description: Learn about Fern's OpenRPC extensions for generating higher-quality SDKs +description: OpenRPC extensions guide for Fern. Use x-fern-ignore, x-fern-examples, x-fern-availability, and more to improve SDK generation. --- Fern supports a variety of OpenRPC extensions that enhance your API specification and generate higher-quality SDKs. diff --git a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx index 902d55406..906eac11f 100644 --- a/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx +++ b/fern/products/docs/pages/component-library/default-components/runnable-endpoint.mdx @@ -1,6 +1,6 @@ --- title: Runnable endpoint -description: Test API endpoints directly from your documentation with an interactive request builder. +description: Add testable API endpoints to your docs with RunnableEndpoint. Support multiple environments, examples, and real-time response previews. --- The `` component lets users make real HTTP requests to your APIs directly in the API Reference. It auto-detects endpoint definitions from your API specification and provides a request builder with inputs for headers, path parameters, query parameters, and request bodies. diff --git a/fern/products/docs/pages/developer-tools/orchestrate-docs-releases.mdx b/fern/products/docs/pages/developer-tools/orchestrate-docs-releases.mdx index e672e81a0..7aeb005f9 100644 --- a/fern/products/docs/pages/developer-tools/orchestrate-docs-releases.mdx +++ b/fern/products/docs/pages/developer-tools/orchestrate-docs-releases.mdx @@ -1,6 +1,6 @@ --- title: Orchestrate releases -description: Coordinate documentation updates across multiple repositories and releases. +description: Automate docs releases based on GitHub repository releases. Set up workflows to trigger auto-merge PRs when features ship. --- Fern Docs supports orchestrating documentation releases based on releases from other repositories. This is useful when documenting features that depend on releases in other repositories. diff --git a/fern/products/docs/pages/integrations/overview.mdx b/fern/products/docs/pages/integrations/overview.mdx index 65ea7a081..9a0efbd65 100644 --- a/fern/products/docs/pages/integrations/overview.mdx +++ b/fern/products/docs/pages/integrations/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Analytics and integrations" -description: "Integrate with third party platforms for analytics, support, etc." +title: Analytics and integrations +description: Connect analytics and support tools to your Fern documentation. Set up PostHog, Segment, FullStory, Intercom, and Postman collections. ---