Shortcode_Controller::get_item_schema()

Summary

Retrieves the response’s schema, conforming to JSON Schema.


Return

(array) Item schema data.


Source

File: src/BigCommerce/Rest/Shortcode_Controller.php

	public function get_item_schema() {

		$schema = [
			'$schema'    => 'http://json-schema.org/draft-04/schema#',
			'title'      => 'bigcommerce_shortcode',
			'type'       => 'object',
			'properties' => [
				'shortcode'  => [
					'description' => __( 'The complete shortcode string', 'bigcommerce' ),
					'type'        => 'string',
					'context'     => [ 'view', 'edit', 'embed' ],
					'readonly'    => true,
				],
				'attributes' => [
					'description' => __( 'The attributes of the shortcode', 'bigcommerce' ),
					'context'     => [ 'view', 'edit', 'embed' ],
					'readonly'    => true,
					'type'        => 'object',
				],
			],
		];

		return $this->add_additional_fields_schema( $schema );
	}

User Contributed Notes

You must log in before being able to contribute a note or feedback.