Add REST API validation notebooks and examples directory#84
Open
Add REST API validation notebooks and examples directory#84
Conversation
validation notebooks for Python and TypeScript.
New structure:
- api-examples/
- README.md (overview of REST API examples)
- publishing/
- README.md (publishing-specific concepts)
- python/validate-rest-api-examples.ipynb
- typescript/validate-typescript-rest-api-example.nnb
Features:
- Python notebook: batch publishing, streaming, updates, production retry logic
- TypeScript notebook: type-safe patterns, native fetch, error handling
- Comprehensive documentation at each level
- Updated main README with "REST API Examples" section
These notebooks validate code examples from the official Fiddler REST API
documentation and serve as production-ready reference implementations for
language-agnostic REST API integration.
| @@ -0,0 +1,607 @@ | |||
| { | |||
Contributor
There was a problem hiding this comment.
@dbasilfid Maybe it's just for me, but the line breaks in this notebook didn't seem to register properly. You have to scroll horizontally for all code blocks:
Contributor
Author
There was a problem hiding this comment.
wow, thanks for catching that. I've never seen VS Code and GitHub render a simple notebook differently. Will investigate.
Contributor
Author
There was a problem hiding this comment.
I cleared the cell outputs (that I should have cleared already), and that has resolved the issue (?). I'll take another pass to see if I missed anything else.
Contributor
There was a problem hiding this comment.
Great! Looks fixed for me too
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
2 participants
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.
Summary
Adds a new
api-examples/directory containing validation notebooks and reference implementations for the Fiddler REST API, starting with event publishing examples in Python and TypeScript.Changes
New Directory Structure
api-examples/publishing/python/with Python REST API notebookapi-examples/publishing/typescript/with TypeScript REST API notebookNotebooks
validate-rest-api-examples.ipynb): Batch publishing, streaming, updates, production-ready retry logicvalidate-typescript-rest-api-example.nnb): Type-safe REST API patterns, native fetch, comprehensive error handlingDocumentation
Purpose
These notebooks serve dual purposes:
Why This Organization?
integration-examples/directory structureTesting
Related Documentation
These notebooks validate examples from: