Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Re-record JSON responses for docs #120

Merged
merged 8 commits into from
Jan 25, 2024
Merged

[chore] Re-record JSON responses for docs #120

merged 8 commits into from
Jan 25, 2024

Conversation

nwithan8
Copy link
Member

@nwithan8 nwithan8 commented Jan 19, 2024

  • Most JSON responses have not changed outside of timestamps.
  • Some have extra data entries (previously one or two records, now three or four).
  • Some deprecated functionality (carbon offset, batch create+buy) have been removed.
  • Added Python tool used to generate these response snippets + improved documentation and Makefile steps

@nwithan8 nwithan8 requested a review from a team as a code owner January 19, 2024 23:59
Copy link
Member

@Justintime50 Justintime50 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like these regenerated using the correct user ID for the responses please, could be some weird artifacts mixed in if not (see internal diff for more details on that)

- gitignore auto-generated response files to avoid bloat
- Update README for better tool documentation
- Fix JSON response tool unit tests
- Fix JSON response snippet tool Makefile
- Lint JSON response snippets
@nwithan8
Copy link
Member Author

I'd like these regenerated using the correct user ID for the responses please, could be some weird artifacts mixed in if not (see internal diff for more details on that)

I have addressed your feedback and re-recorded all the cassettes with the proper API keys, did result in a lot less diffs.

I've also added the Python tool we use to generate these snippets into the tools directory and improved its documentation so it will be easier next time around to carry out this process.

@nwithan8 nwithan8 merged commit b83bc05 into master Jan 25, 2024
9 checks passed
@nwithan8 nwithan8 deleted the doc_responses branch January 25, 2024 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants