docs: clarify api-name is only for multiple APIs #3400
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Updates the
api-nameproperty 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 useapi-nameand 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
api-namewith a single API actually produces an errorNotes
Requested by kenny
Link to Devin run: https://app.devin.ai/sessions/8509e6be62b24fe1ade2e775879c325a