docs: add troubleshooting section to contributing guide #897
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
damcou
reviewed
Aug 4, 2022
|
|
||
| You might want to send additional information to the generators that have no link with your REST API. To do so, you can add parameters starting with `x-` at the root level of your spec, which will be available in the mustache template under the `vendorExtensions` object. | ||
| #### Force the name of a `requestBody` |
There was a problem hiding this comment.
I find titles with #### hard to discern and the separation of the different troubleshooting points is not clear enough. Maybe adding a dash or a number would help ?
There was a problem hiding this comment.
Do you mean via the file, or the website? The preview looks nice: https://deploy-preview-897--api-clients-automation.netlify.app/docs/contributing/add-new-api-client
shortcuts
force-pushed
the
docs/contributing-guide
branch
from
5febc04 to
df30ed7
Compare
shortcuts
force-pushed
the
docs/contributing-guide
branch
from
df30ed7 to
1b61c2f
Compare
shortcuts
force-pushed
the
docs/contributing-guide
branch
from
1b61c2f to
64b536f
Compare
algolia-bot
added a commit
to algolia/algoliasearch-client-javascript
that referenced
this pull request
Aug 8, 2022
algolia/api-clients-automation#897 Co-authored-by: Clément Vannicatte <[email protected]>
medicindev
pushed a commit
to medicindev/Algolia-Client--JavaScript
that referenced
this pull request
Mar 8, 2025
algolia/api-clients-automation#897 Co-authored-by: Clément Vannicatte <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🧭 What and Why
🎟 JIRA Ticket: -
Changes included:
Follow up of the "discovery" in #896
This PR updates the contributing guide "Add a new API client" so we don't forget what is this property about
🧪 Test
Netlify preview