Add reference and API docs for segments #1474
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
There's been no previous need for GET or DELETE requests, but now that we do need them, the payload shouldn't show up as `undefined`
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/unleash-team/unleash-docs/2KREHN4wxWcwUkpyEXMcvkriEvgo |
Coverage report
Test suite run success834 tests passing in 120 suites. Report generated by 🧪jest coverage report action from 35bd047 |
olav
suggested changes
Apr 4, 2022
olav
approved these changes
Apr 4, 2022
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 adds reference documentation and API documentation for the new segments feature.
It also adds some minor work with storybook to add the API request component and converts it to TS.
Points of attention
I'd like to ask @olav to pay special attention to the API documentation: are the return codes correct? Is the returned data correct? I've used the segments controller as reference, so I think it's all there, but I might have missed something.
Thank you! 😄