chore(docs): add documentation about 'test' provider and update test payloads

[dmitsh]

Description

add documentation about 'test' provider
update test payloads

Checklist

• I am familiar with the Contributing Guidelines.
• New or existing tests cover these changes.
• The documentation is up to date with these changes.
• All commits are signed off per DCO (git commit -s).

[greptile-apps]

Greptile Summary

This PR adds documentation for the test provider, updates docs/api.md with clearer payload structure and HTTP method prefixes, adds the test provider to docs/overview.md and docs/index.yml, and renames existing payload files by dropping the redundant test- prefix while adding two new payloads (test-block.json, test-tree.json). All changes are documentation and test-fixture only — no production code is modified.

Confidence Score: 5/5

Safe to merge — documentation and test fixture changes only, with no production code modifications.

All findings are P2 style nits (em-dash inconsistency in overview.md, indentation in test-block.json). No logic or correctness issues were found. Model file references in payloads are valid, and directory references in docs point to real paths.

No files require special attention.

Important Files Changed

Filename	Overview
docs/providers/test.md	New documentation page for the test provider — well-structured with API flow tables, parameter reference, processing behavior, examples, and a curl workflow. References to tests/integration/ and tests/payloads/ are valid directories.
docs/api.md	Improved payload documentation with HTTP method prefixes on URLs, restructured provider/engine/nodes sections, and fixed a trailing comma in the JSON example.
docs/overview.md	Test provider added to both the supported providers list and the 'Choosing a Provider' table; minor style inconsistency (hyphen vs em dash) on the new entry.
docs/index.yml	Navigation entry for the new test provider page added correctly under the Providers section.
tests/payloads/test-block.json	New test payload for block topology using large.yaml model; has inconsistent 8-space indentation in the params object.
tests/payloads/test-tree.json	New minimal test payload for tree topology using the default built-in model; consistent formatting.
tests/payloads/aws-sim-block.json	Renamed from test-aws-sim-block.json; no content changes.

Sequence Diagram

sequenceDiagram
    participant Client
    participant Topograph
    participant TestProvider

    Client->>Topograph: POST /v1/generate (provider.params.generateResponseCode)
    alt generateResponseCode 4xx-5xx
        Topograph-->>Client: Error response + errorMessage (no request ID)
    else generateResponseCode 202
        Topograph->>TestProvider: Enqueue request (after requestAggregationDelay)
        Topograph-->>Client: 202 Accepted + request ID
        loop Poll until done
            Client->>Topograph: GET /v1/topology?uid=<id>
            alt Still queued / processing
                Topograph-->>Client: 202 Accepted
            end
        end
        TestProvider->>Topograph: Process (load modelFileName, run engine)
        alt topologyResponseCode 200
            Topograph-->>Client: 200 OK + topology output
        else topologyResponseCode 202
            Topograph-->>Client: 202 Accepted (forever / until timeout)
        else topologyResponseCode 4xx-5xx
            Note over Topograph: Internal retries for 408/429/500/502/503/504
            Topograph-->>Client: Error response + errorMessage
        end
    end

Loading

_{Reviews (3): Last reviewed commit: "chore(docs): add documentation about 'te..." | Re-trigger Greptile}

[greptile-apps]

Test provider missing from overview navigation

docs/overview.md enumerates every provider under "Supported Environments" with a link to its doc page, but the new test provider is not listed there. A reader browsing the overview won't discover this page. Even a brief entry (e.g., under a separate "Development / Testing" heading) would make it discoverable without cluttering the production provider list.

[github-actions]

🌿 Preview your docs: https://nvidia-preview-pull-request-299.docs.buildwithfern.com/topograph

[ravisoundar]

lgtm

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.13%. Comparing base (1875ab8) to head (7afe4bd).
⚠️ Report is 32 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #299      +/-   ##
==========================================
- Coverage   68.46%   68.13%   -0.33%     
==========================================
  Files          82       81       -1     
  Lines        4842     4805      -37     
==========================================
- Hits         3315     3274      -41     
  Misses       1395     1395              
- Partials      132      136       +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.