Skip to content

Commit 7a185d4

Browse files
Merge pull request #461 from aignostics/docs/update-platform-spec-post-v1.1.0
FR-04: Added test as a supported deployment environment alongside production, staging, and development ApplicationRun.results(): Updated spec to document the item_ids and external_ids filter parameters (and nocache), reflecting the API introduced in v1.1.0
2 parents 834fbc3 + 629185b commit 7a185d4

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

specifications/SPEC_PLATFORM_SERVICE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Platform Module shall:
2222
- **[FR-01]** Provide secure OAuth 2.0 authentication with support for both Authorization Code with PKCE and Device Authorization flows
2323
- **[FR-02]** Manage JWT token lifecycle including acquisition, caching, validation, and refresh operations
2424
- **[FR-03]** Configure and provide authenticated API clients for interaction with Aignostics Platform services
25-
- **[FR-04]** Support multiple deployment environments (production, staging, development) with automatic endpoint configuration
25+
- **[FR-04]** Support multiple deployment environments (production, staging, development, test) with automatic endpoint configuration
2626
- **[FR-05]** Provide CLI commands for user authentication operations (login, logout, whoami)
2727
- **[FR-06]** Handle authentication errors with retry mechanisms and fallback flows
2828
- **[FR-07]** Support proxy configurations and SSL certificate handling for enterprise environments
@@ -313,8 +313,13 @@ class ApplicationRun:
313313
def cancel(self) -> None:
314314
"""Cancels the application run."""
315315

316-
def results(self) -> Iterator[ItemResultData]:
317-
"""Retrieves the results of all items in the run."""
316+
def results(
317+
self,
318+
nocache: bool = False,
319+
item_ids: list[str] | None = None,
320+
external_ids: list[str] | None = None,
321+
) -> Iterator[ItemResultData]:
322+
"""Retrieves the results of items in the run, optionally filtered by item or external IDs."""
318323

319324
def item_status(self) -> dict[str, ItemStatus]:
320325
"""Retrieves the status of all items in the run."""

0 commit comments

Comments
 (0)