Skip to content

docs: document namespace prefix syntax for endpoint references#3679

Merged
devalog merged 3 commits into
mainfrom
fern/document-namespace-endpoint-references
Feb 19, 2026
Merged

docs: document namespace prefix syntax for endpoint references#3679
devalog merged 3 commits into
mainfrom
fern/document-namespace-endpoint-references

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented Feb 18, 2026

Summary

Documents the namespace::METHOD /path syntax for endpoint references when using namespaces (multiple API specs). This is relevant wherever endpoints are specified in METHOD /path format — for example, payments::POST /oauth/token instead of POST /oauth/token.

Files changed (10):

  • OAuth auth config (auth.mdx): Added <Tip> callout in the OAuth client credentials accordion
  • OAuth snippets (oauth-get-token.mdx, oauth-refresh-token.mdx): Updated endpoint ParamField descriptions
  • API Reference layout (customize-api-ref.mdx): Added namespace example in the OpenAPI "Ordering top-level sections" tab
  • Component docs (endpoint-request-snippet.mdx, endpoint-response-snippet.mdx, endpoint-schema-snippet.mdx, runnable-endpoint.mdx): Updated endpoint ParamField descriptions
  • OpenAPI spec settings (openapi-specs.mdx): Updated settings.filter.endpoints ParamField description
  • Project structure (project-structure.mdx): Added link from "Add namespaces" step to the generators.yml reference for configuration details

Additionally, endpoint-schema-snippet.mdx was missing a Properties section entirely — one was added with endpoint and selector param documentation alongside the namespace info.

Updates since last revision

  • All namespace links now point to the project structure page instead of the generators.yml reference page. The project structure page's "Add namespaces" step links back to generators.yml#namespace for configuration details.
  • Standardized all example namespace names to payments (previously a mix of iam and myapi) for consistency with the project-structure page's payments-api example.

Review & Testing Checklist for Human

  • Verify the #combined-sdks-from-multiple-apis anchor resolves correctly on the project-structure page. All namespace links across 9 files now point to this anchor. If the heading slug doesn't match, every link will be broken.
  • Verify the #namespace anchor exists on the generators-yml reference page (/learn/sdks/reference/generators-yml#namespace). The project-structure page now links there from the "Add namespaces" step.
  • Review the new Properties section added to endpoint-schema-snippet.mdx — this is additive beyond just namespace docs. Confirm the selector values listed (request, request.path, request.query, request.body, response, response.body) are accurate and complete.
  • Spot-check that payments is used consistently as the example namespace name across all changed files. Previously a mix of iam and myapi was used; verify no stale references remain.
  • Check rendered output on the preview deployment — click through namespace links from at least 2-3 of the changed files to confirm they land on the correct section of the project-structure page.

Suggested test plan: Open the preview deployment, navigate to the OAuth auth config page, click the namespace link in the Tip callout, and verify it lands on the "Combined SDKs from multiple APIs" section of the project-structure page. From there, verify the "Add namespaces" step links to the generators.yml reference. Repeat for one component doc page (e.g., endpoint-request-snippet). Grep the diff for iam:: and myapi:: to confirm no stale namespace names remain.

Notes

  • Two files (oauth-get-token.mdx, oauth-refresh-token.mdx) had missing trailing newlines which were incidentally fixed.
  • Requested by: Fern Support
  • Link to Devin run

Co-Authored-By: Fern Support <info@buildwithfern.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@devalog devalog merged commit f2789ac into main Feb 19, 2026
2 checks passed
@devalog devalog deleted the fern/document-namespace-endpoint-references branch February 19, 2026 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants