Skip to content

docs: use $request./$response. prefixes in OAuth generators.yml examples - #7058

Merged
nerminamiller-postman merged 1 commit into
mainfrom
devin/1790108363-oauth-prefix-docs
Sep 22, 2026
Merged

nerminamiller-postman merged 1 commit into
mainfrom
devin/1790108363-oauth-prefix-docs

Conversation

@devin-ai-integration

Copy link
Copy Markdown
Contributor

Summary

The OAuth auth-schemes examples showed bare property names (access-token: access_token), but the CLI's valid-oauth rule rejects these:

OAuth configuration for endpoint auth.getToken must define a dot-delimited 'access-token' property starting with $response (e.g. $response.access-token).

A customer copied the example verbatim and hit this error. This updates every OpenAPI-side OAuth example to the accepted form ($request.<prop> under request-properties, $response.<prop> under response-properties), matching what the Fern Definition auth page already shows, and adds one sentence on the OpenAPI auth page stating the requirement.

Files: api-def/openapi/auth.mdx, sdks/snippets/oauth-params.mdx, sdks/snippets/oauth-get-token.mdx, sdks/snippets/oauth-refresh-token.mdx.

Link to Devin session: https://app.devin.ai/sessions/6cee3719d44049ffbc026381ca46ec46
Open in Devin Desktop: https://app.devin.ai/desktop/session/6cee3719d44049ffbc026381ca46ec46?variant=devin

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".

  • Disable automatic comment, CI, and merge conflict monitoring

@github-actions

Copy link
Copy Markdown
Contributor

@nerminamiller-postman
nerminamiller-postman merged commit 8173d8f into main Sep 22, 2026
5 checks passed
@nerminamiller-postman
nerminamiller-postman deleted the devin/1790108363-oauth-prefix-docs branch September 22, 2026 21:56
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