API Responses ReadAssertionsResponse - evansims/openfga-php GitHub Wiki
Response containing test assertions associated with an authorization model. This response provides access to test assertions that validate authorization model behavior. These assertions define expected outcomes for specific authorization scenarios and help ensure model correctness.
Table of Contents
OpenFGA\Responses
- ReadAssertionsResponseInterface (interface)
- ReadAssertionsRequest (request)
Implements Responses\ReadAssertionsResponseInterface
public function fromResponse(
HttpResponseInterface $response,
HttpRequestInterface $request,
SchemaValidatorInterface $validator,
): staticCreate a response instance from an HTTP response. This method transforms a raw HTTP response from the OpenFGA API into a structured response object, validating and parsing the response data according to the expected schema. It handles both successful responses by parsing and validating the data, and error responses by throwing appropriate exceptions.
| Name | Type | Description |
|---|---|---|
$response |
HttpResponseInterface |
The raw HTTP response from the OpenFGA API |
$request |
HttpRequestInterface |
The original HTTP request that generated this response |
$validator |
SchemaValidatorInterface |
Schema validator for parsing and validating response data |
static — The parsed and validated response instance containing the API response data
public function getAssertions(): ?OpenFGA\Models\Collections\AssertionsInterfaceGet the collection of assertions from the authorization model. Returns a type-safe collection containing the assertion objects associated with the authorization model. Each assertion defines a test case with expected permission check results for validating model behavior.
AssertionsInterface | null — The collection of assertions, or null if no assertions are defined
public function getModel(): stringGet the authorization model identifier for these assertions. Returns the unique identifier of the authorization model that contains these assertions. This ties the assertions to a specific model version for validation and testing purposes.
string — The authorization model identifier
Implements Responses\ReadAssertionsResponseInterface
public function schema(): SchemaInterfaceGet the schema definition for this response. Returns the schema that defines the structure and validation rules for assertions reading response data, ensuring consistent parsing and validation of API responses.
SchemaInterface — The schema definition for response validation