| Method | Description | |
|---|---|---|
| __construct ( string $version, string $service ) | SpecManager constructor. | |
| getDefinitions ( string $filter = null ) : array | Get Object definition | |
| getPathParameters ( string $path ) : array | Return endpoint parameters | |
| getPathTemplates ( string $method = null ) : string[] | The list of endpoints in Api specifications | |
|
getResponse ( string $path, string $method, integer $httpCode ) : |
Get Response definitions with Api endpoint |
| Method | Description | |
|---|---|---|
| checkPath ( string $path ) | Check if path not exist, will throw exception | |
|
getPath ( variadic |
Return Api definitions from segment | |
|
resolveReferences ( array $schema, mixed $specObject = null, mixed $objectName = null ) : |
Resolve schema references to object |
| public __construct ( string $version, string $service ) | ||
| $version | string | Api version |
| $service | string | spec file service |
| public getDefinitions ( string $filter = null ) : array | ||
| $filter | string | optional The pattern to filter for object definition in specification if the name of the object matched the filter this object will not be included in return result |
| return | array | |
| public getPathParameters ( string $path ) : array | ||
| $path | string | Api endpoint |
| return | array | |
| public getPathTemplates ( string $method = null ) : string[] | ||
| $method | string | HTTP method |
| return | string[] | |
|
public getResponse ( string $path, string $method, integer $httpCode ) : |
||
| $path | string | Api endpoint |
| $method | string | HTTP method |
| $httpCode | integer | HTTP code |
| return | ||
|
protected resolveReferences ( array $schema, mixed $specObject = null, mixed $objectName = null ) : |
||
| $schema | array | segment Api specifications |
| $specObject | mixed | optional object schema view |
| $objectName | mixed | optional object property name |
| return | ||
