Skip to content

History / API Documentation

Revisions

  • Add full XML-RPC method reference for all 87 methods We paused writing test cases via automated API calls partway through (covered Utility/Auth, Users, Projects - 20 categories in) because writing them by hand from documentation was preferred going forward. This page gives that documentation: every registered tl.* method's required/optional parameters, return shape, and behavior, organized by category. For the 20 methods actually dogfooded live against a running instance (Utility/Auth, Users, Projects), the entries reflect verified behavior, including six real bugs found and fixed this session (#450-#456). For the remaining ~65 methods, the entries come from reading xmlrpc.class.php directly (param names, docblocks, control flow) without live testing. Six additional issues turned up this way and are called out explicitly as unverified leads rather than confirmed defects - most notably updateTestSuiteCustomFieldDesignValue returning from inside its loop (only ever reports the first custom field) and getTestSuite building its permission check from an undefined variable. Linked from API-Documentation.md's XMLRPC section.

    @sebiboga sebiboga committed Aug 17, 2026
  • Replace inaccurate XMLRPC method list with the verified registry The old 'Common Methods' list named tl.whoami and tl.getBuilds, neither of which exist in this codebase's callback registry (lib/api/xmlrpc/v1/xmlrpc.class.php). Replaced with the full list of all 89 registered method names, grouped by area, pulled directly from the source.

    @sebiboga sebiboga committed Aug 17, 2026
  • Remove fixed duplicate external_id known issue note Issue #450 is fixed - tl.createTestCase's response no longer contains a duplicate external_id struct member.

    @sebiboga sebiboga committed Aug 17, 2026
  • Document the XMLRPC API with working examples The XMLRPC section only listed method names with no request format, auth flow, or examples - unlike REST v3, which has both. Filled in: - How to get a personal devKey from the UI (My Settings > API interface). - The raw XML request/response shape, since this is not REST/JSON. - Working tl.createTestSuite and tl.createTestCase examples with curl, verified against a running instance rather than written from the method signatures alone. - A note on issue #450 (duplicate external_id struct member in the createTestCase response), found while verifying the examples. Also corrected the XMLRPC snippet in Developer-Guide.md, which called tl.createTestCase with three positional string arguments; the method takes a single struct and several of the fields it omitted (testprojectid, authorlogin, summary, steps) are required and the call would fail without them.

    @sebiboga sebiboga committed Aug 17, 2026
  • Add comprehensive API documentation (REST v3, v2, v1 and XMLRPC v1) - Document REST API v3 endpoints - Provide authentication examples - Include request/response formats - Add working code examples - Document XMLRPC API v1 - Best practices and security guidelines Addresses missing API documentation for issue #88

    @sebiboga sebiboga committed Aug 16, 2026