Repository navigation
Update docs: - #18
Merged
Merged
Update docs:#18
Conversation
index.mdx - Fixed CLI command: glassgen generate → glassgen generate-data - Removed dead links to /configuration and /examples (those pages don't exist) getting-started.mdx - Fixed CLI command to glassgen generate-data - Added generate() reference section documenting all three parameters (config, schema, sink) and the return type difference (dict vs generator) - Added generate_one() reference with example - Expanded generator config table to document bulk_size and the rps: 0 / rps > 2500 behavior - Documented num_records: -1 for infinite generation - Added a full Event Duplication section documenting event_options.duplication (this feature was mentioned in the feature list but had zero docs on how to use it) - Removed dead link to /examples generators.mdx - Added three previously undocumented generators: $prefixed_id, $array, and $query_string - Fixed $price default range description (was implying ~99.99; actual defaults are 0.99–9999.99) - Clarified $float range behavior (unbounded, can be negative or very large) - Merged $uuid and $uuid4 descriptions — both produce UUID v4; they are identical sinks/webhook.mdx - Removed false claim of "Automatic retries" — the sink makes one attempt per record with no retry logic - Removed "SSL certificate verification" from the configurable security features — it is always on and not configurable - Added a note that Content-Type: application/json is always injected automatically sinks/custom.mdx - Clarified that publish_bulk() is what the engine calls, not publish() - Added explicit note that custom sinks must be passed via sink= parameter — they cannot be used via the config "sink" block sinks/yield.mdx - Documented the return type difference: generate() returns a generator (not a dict) when using yield sink - Added a code example showing how to capture the response metadata (time_taken_ms, num_records) after iteration using StopIteration.value - Added infinite generation example with num_records: -1
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Test Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contributor
Test Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This branch was successfully deployed
This file contains hidden or 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
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.
index.mdxgetting-started.mdxgenerators.mdxsinks/webhook.mdxsinks/custom.mdxsinks/yield.mdx