Add usage tips to README #334
Merged
Conversation
This file contains 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
cjbooms
approved these changes
Nov 25, 2024
README.md
Outdated
|
|
||
| While inline schemas are perfectly valid they are not supported by Fabrikt in all circumstances. | ||
| This is especially true for request bodies and non-trivial parameters. Instead, define your schemas in the | ||
| components section of the OpenAPI spec (`components.parameters` & `components.requestBodies`). |
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.
This PR aims to enhance the Fabrikt README by adding helpful pointers to ensure users can get the most out of the tool 🚀.
There are a few well-known gotchas that have been raised in issues, so we thought it would be valuable to document them here. This should reduce the chances of users giving up on Fabrikt with the impression that “It’s not working!” and instead help them troubleshoot effectively.
Any other gotchas worth mentioning?
Cc/ @cjbooms, @acanda, @averabaq, ..?