docs(specs): Review OpenAPI A/B testing specs #1746
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
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
kai687
approved these changes
Jul 14, 2023
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 reviews the A/B testing API.
🧭 What and Why
Questions and notes
listABTests
In the response, the difference between
countandtotalis confusing. For instance, I listed the A/B tests on G6TRZ8PT96:count= 10 andtotal= 12. The original text implies that:It feels like the descriptions are the wrong way around.
Why can’t some tests be retrieved? Because they’ve been deleted? Only due to deletion? Or due to being outside the analytics retention window of 90 to 365 days?
In the response, under
abtests > variants > averageClickPosition, what does a click position of0indicate? No click events? Or doesnullindicate no click events?🎟 JIRA Ticket: DOC-1113
Changes included:
Update summary, description and examples
🧪 Test