API Models SourceInfo - evansims/openfga-php GitHub Wiki
Represents source file information for debugging and development tools. SourceInfo provides metadata about where elements of your authorization model were originally defined, including file paths. This information is valuable for development tools, error reporting, and debugging authorization model issues. Use this when you need to trace authorization model elements back to their source definitions for debugging or tooling purposes.
Table of Contents
OpenFGA\Models
SourceInfoInterfaceJsonSerializableModelInterface
- SourceInfoInterface (interface)
| Name | Value | Description |
|---|---|---|
OPENAPI_MODEL |
SourceInfo |
public function getFile(): stringGet the source file path where the model element was defined. This provides debugging and tooling information about the original source file location for the model element. This is particularly useful for development tools, error reporting, and tracing model definitions back to their source.
string — The source file path where the element was defined
public function jsonSerialize(): arrayarray
Implements Models\SourceInfoInterface
public function schema(): SchemaInterfaceGet the schema definition for this model. This method returns the schema that defines the structure, validation rules, and serialization behavior for this model class. The schema is used for data validation, transformation, and ensuring consistency across API operations with the OpenFGA service. Each model's schema defines: - Required and optional properties - Data types and format constraints - Nested object relationships - Validation rules and business logic constraints The schema system enables the SDK to automatically validate incoming data, transform between different representations, and ensure compliance with the OpenFGA API specification.
SchemaInterface — The schema definition containing validation rules and property specifications for this model