Documentation

pm_Hook_ApiRest
in package
implements pm_Hook_Interface

Hook for getting REST API metadata

Tags
since
18.0.44

Interfaces, Classes and Traits

pm_Hook_Interface
Generic interface for hooks

Table of Contents

getSchema()  : array<string|int, mixed>
Retrieve REST API schema information

Methods

getSchema()

Retrieve REST API schema information

public abstract getSchema() : array<string|int, mixed>
[
    [
        'name' => 'My Extension REST API v1.0 (Beta)',
        'url' => '/api/my-extension/schema/openapi',
    ],
    [
        'name' => 'My Extension REST API v0.2',
        'url' => '/modules/my-extension/public/swagger.json',
    ],
    ...
]
Return values
array<string|int, mixed>

Search results