Skip to content

Addition of Examples and documentation correction - #18

Merged
jaleman-vdr-wikimedia merged 3 commits into
wikimedia-enterprise:mainfrom
jaleman-vdr-wikimedia:main
Oct 27, 2025
Merged

Addition of Examples and documentation correction#18
jaleman-vdr-wikimedia merged 3 commits into
wikimedia-enterprise:mainfrom
jaleman-vdr-wikimedia:main

Conversation

@jaleman-vdr-wikimedia

Copy link
Copy Markdown
Contributor

This commit includes corrections to example readme's as well as 2 new examples that were not present in the SDK.

This commit includes the following changes:

- Updated README docs, to reflect correct script invocation.

- Updated api_client to support utf-8 encoding of tar files, and also configured it to follow redirects. This was done so the structuredcontentsnapshots worked as expected.

- Fixed a small logic error in structuredcontentsnapshots' example that caused it to crash on exit, instead of gracefully shutting down.
This commit includes examples to showcase the behavior described in the READMEs of Batches and Metadata.
@jaleman-vdr-wikimedia jaleman-vdr-wikimedia self-assigned this Oct 23, 2025
@jaleman-vdr-wikimedia jaleman-vdr-wikimedia added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 23, 2025
This commit includes two new examples:

1) A new example to demonstrate the behavior described in the snapshots example.

2) A new example to demonstrate custom client configuration.
@jaleman-vdr-wikimedia
jaleman-vdr-wikimedia merged commit 3731b3a into wikimedia-enterprise:main Oct 27, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants