-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
exampleImprovements or additions to examplesImprovements or additions to examples
Description
Pain Points:
- Strict dependencies across multiple metadata objects.
- Mismatched or incorrect IDs can lead to reference issues, while configuring aliases for every case adds extra maintenance effort.
- Large amount of boilerplate code required for basic operations.
- Manual client cleanup can lead to lingering connections, and clearer documentation with examples using
with/usingpatterns would help prevent this. In addition, some users may prefer to instantiate clients at the start of a workflow and close them at the end, so guidance or best practices to manage long‑lived connections would also be valuable.
Impact:
- Heavy trial‑and‑error development, as users must repeatedly experiment to discover the correct object sequence and relationships.
- Huge development time.
Suggestions:
- Offer alias‑based referencing examples as an alternative to using raw IDs.
- Add examples of demonstrating APIs that support automatic cleanup.
- Practical examples with boilerplate‑free JSON integration patterns to simplify development and reduce complexity.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
exampleImprovements or additions to examplesImprovements or additions to examples