Astra_Abstract_Ability::build_output_schema( array $data_properties )
Build a standardized output schema wrapping data properties in the Astra_Abilities_Response::success() format.
Description
Parameters
- $data_properties
-
(array) (Required) Properties for the 'data' key.
Return
(array) Full output schema.
Source
File: inc/abilities/class-astra-abstract-ability.php
protected function build_output_schema( $data_properties ) {
return array(
'type' => 'object',
'required' => array( 'success', 'message' ),
'properties' => array(
'success' => array(
'type' => 'boolean',
'description' => 'Whether the operation succeeded.',
),
'message' => array(
'type' => 'string',
'description' => 'Human-readable result message.',
),
'data' => array(
'type' => 'object',
'properties' => $data_properties,
),
),
);
}
Expand full source code Collapse full source code View on Trac