Skip to content

Improving Developer Experience by Simplifying Manual Integration Steps #106

@sabarinathan-ni

Description

@sabarinathan-ni

Pain Points:

  1. Strict dependencies across multiple metadata objects.
  2. Mismatched or incorrect IDs can lead to reference issues, while configuring aliases for every case adds extra maintenance effort.
  3. Large amount of boilerplate code required for basic operations.
  4. Manual client cleanup can lead to lingering connections, and clearer documentation with examples using with/using patterns 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:

  1. Heavy trial‑and‑error development, as users must repeatedly experiment to discover the correct object sequence and relationships.
  2. Huge development time.

Suggestions:

  1. Offer alias‑based referencing examples as an alternative to using raw IDs.
  2. Add examples of demonstrating APIs that support automatic cleanup.
  3. Practical examples with boilerplate‑free JSON integration patterns to simplify development and reduce complexity.

AB#3744864

Metadata

Metadata

Assignees

No one assigned

    Labels

    exampleImprovements or additions to examples

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions