Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions fern/products/api-def/openapi-pages/automation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ subtitle: Pull your latest OpenAPI Specification into your Fern Folder automatic

<Markdown src="/snippets/agent-directive.mdx"/>

Automatically pull your latest OpenAPI spec from a publicly available URL into your fern folder using the [sync-openapi GitHub Action](https://github.com/fern-api/sync-openapi). This keeps your committed spec in sync with your live API without manual updates.
Automatically pull your latest OpenAPI spec from a publicly available URL into your fern folder using the [sync-openapi GitHub Action](https://github.com/fern-api/sync-openapi). This keeps your committed spec in sync with your live API without manual updates. The sync-openapi action and the `fern api update` CLI command are available on all [plans](https://buildwithfern.com/pricing).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] reported by reviewdog 🐶
[FernStyles.Current] Avoid time-relative terms like 'latest' that become outdated


## Setup
<Steps>
Expand Down Expand Up @@ -61,4 +61,14 @@ This creates daily pull requests with any API spec updates. To change the freque

## Other use cases

If your OpenAPI spec lives in a different repository (rather than at a public URL), you can sync it to your Fern folder using explicit file mappings. See the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi) for this and other advanced configurations.
If your OpenAPI spec lives in a different repository (rather than at a public URL), you can sync it to your Fern folder using explicit file mappings. See the [sync-openapi GitHub Action README](https://github.com/fern-api/sync-openapi) for this and other advanced configurations.

## Where to store your OpenAPI spec

Fern customers typically manage their OpenAPI specs in one of three ways:

- **Sync from your source code repository.** Keep your OpenAPI spec in the same repo as your API source code and use the [sync-openapi GitHub Action](#setup) or the [`fern api update`](/cli-api-reference/cli-reference/commands#fern-api-update) CLI command to pull updates into your Fern docs repo automatically.
- **Host at a public URL.** Serve the spec from a publicly accessible endpoint (for example, `https://api.example.com/openapi.json`) and configure the [`origin`](/learn/sdks/reference/generators-yml#openapi) field in `generators.yml` so Fern can fetch it.
- **Commit directly into the Fern docs repo.** Check your OpenAPI spec file into the same repository that contains your `docs.yml` and Markdown pages. This is the simplest approach when you don't need to keep a separate source of truth.

The first and third options are the most common. Hosting at a public URL is useful when you want a single canonical spec that multiple consumers can reference.
2 changes: 2 additions & 0 deletions fern/products/docs/pages/authentication/rbac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ roles:
- admins
```

There is no limit on the number of roles you can define. For example, you can create a separate role for each partner so that every partner only sees their own content.

Every user automatically has the `everyone` role, including unauthenticated visitors. If a user lacks the required role or isn't authenticated, Fern redirects them to your login page.

## Restricting content
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Prefer to set things up manually using the CLI? See the [Quickstart](/learn/docs

When you complete the self-service workflow, Fern publishes your documentation to a brand-new site and creates a GitHub repository containing your site configuration (`docs.yml`), Markdown pages, and any API specifications. Your repo includes a `CLAUDE.md` file pre-populated with Fern documentation in [llms-full.txt format](/learn/docs/ai/llms-txt), giving AI coding assistants context for working with Fern.

After setup, you have full ownership of this repository. Push changes to your main branch to trigger an automatic rebuild and publish of your docs, or manage settings through the [Fern Dashboard](https://dashboard.buildwithfern.com).

The setup process also creates and configures:

- **Organization**: An organization using your org ID, with you as a member.
Expand Down Expand Up @@ -48,7 +50,7 @@ Enter an existing website URL (like your marketing site or blog) so Fern can aut
</Frame>
</Step>
<Step title="Your site is live!">
Fern publishes your documentation to a live URL you can visit immediately. You can also add your GitHub account as a collaborator to push changes and manage the repository, or head to the [Dashboard](/learn/dashboard/getting-started/overview) to manage your site settings.
Fern publishes your documentation to a live URL you can visit immediately. Add your GitHub account as a collaborator to take ownership of the repository. From there, you can edit files, push changes, and open pull requests just like any other Git repo. Each push to the main branch triggers the GitHub Action to rebuild and publish your docs automatically. You can also manage your site settings in the [Dashboard](/learn/dashboard/getting-started/overview).
<Frame>
![Site published success screen](./images/site-published.png)
</Frame>
Expand Down
4 changes: 2 additions & 2 deletions fern/products/docs/pages/integrations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ description: Connect analytics and support tools to your Fern documentation. Set
/>

<Card
title="Postman (deprecated)"
title="Postman"
href="/docs/integrations/postman"
horizontal
icon={<img src="https://www.svgrepo.com/show/354202/postman-icon.svg" />}
Expand Down Expand Up @@ -95,4 +95,4 @@ are available during the workflow run.

<Markdown src="/snippets/enterprise-plan.mdx"/>

If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript).
If you want to integrate with a third-party analytics or support platforms that Fern doesn't directly support, you can do so [using custom JS](/docs/customization/custom-css-js#custom-javascript).
14 changes: 12 additions & 2 deletions fern/products/docs/pages/integrations/postman.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
---
title: Postman integration
description: Generate Postman collections from API definitions with Fern. Create example requests and responses for testing and exploring APIs.
description: Publish Postman collections as Fern docs sites, or import your OpenAPI spec into Postman directly.
---

<Markdown src="/snippets/agent-directive.mdx"/>

Fern's Postman integration is no longer actively maintained. To get your API endpoints into Postman, import your OpenAPI specification directly. See [Postman's OpenAPI import docs](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/) for instructions.
## Publish Postman collections to Fern

Postman's publish-to-Fern integration lets you generate a Fern docs site directly from a Postman collection. This integration is available on all Postman and [Fern plans](https://buildwithfern.com/pricing).

<Note>
Postman users on the free tier must create a Postman organization before using this flow. On Fern's side, each organization can create up to 5 docs sites, of which 1 can be published on a [custom domain](/learn/docs/preview-publish/setting-up-your-domain). Additional sites or custom domains require the [Team plan](https://buildwithfern.com/pricing).
</Note>

## Fern-to-Postman generator (deprecated)

Fern's Postman collection generator is no longer actively maintained. To get your API endpoints into Postman, import your OpenAPI specification directly. See [Postman's OpenAPI import docs](https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/) for instructions.
Loading