Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jan 30, 2026

Summary

Updates the api-name property description in the API Reference configuration table to clarify that it can't be used with a single API. This addresses confusion where users with a single API reference try to use api-name and encounter an error.

Before: "Name of the API you're referencing, if there are multiple APIs"

After: "Name of the API you're referencing. Required when you have multiple APIs, but can't be used with a single API."

Review & Testing Checklist for Human

  • Verify the documentation accurately reflects CLI behavior - test that using api-name with a single API actually produces an error
  • Confirm the wording is clear and helpful for self-serve users

Notes

Requested by kenny

Link to Devin run: https://app.devin.ai/sessions/8509e6be62b24fe1ade2e775879c325a

Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
@devin-ai-integration
Copy link
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

| ---------------- | ------------------------------------------------------------------------------------------------------- |
| `api` (required) | Title of the API Reference Section |
| `api-name` | Name of the API you're referencing, if there are [multiple APIs](#include-more-than-one-api-reference) |
| `api-name` | Name of the API you're referencing. Required when you have [multiple APIs](#include-more-than-one-api-reference), but cannot be used with a single API. |
Copy link
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 🐶
[Microsoft.Contractions] Use 'can't' instead of 'cannot'.

@github-actions
Copy link
Contributor

Co-Authored-By: kenny@buildwithfern.com <kenny@buildwithfern.com>
@github-actions
Copy link
Contributor

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.

0 participants