PhalconRest\Export\Documentation\ApiEndpoint::getDescription PHP Method

getDescription() public method

public getDescription ( )
    public function getDescription()
    {
        return $this->description;
    }

Usage Example

 public function transform(DocumentationEndpoint $endpoint)
 {
     return ['name' => $endpoint->getName(), 'description' => $endpoint->getDescription(), 'httpMethod' => $endpoint->getHttpMethod(), 'path' => $endpoint->getPath(), 'exampleResponse' => $endpoint->getExampleResponse(), 'allowedRoles' => $endpoint->getAllowedRoles()];
 }