TribeEventsRESTV1Endpoints__Archive_Category::get_documentation()

Returns an array in the format used by Swagger 2.0.

Return
Source
Changelog

While the structure must conform to that used by v2.0 of Swagger the structure can be that of a full document or that of a document part. The intelligence lies in the "gatherer" of information rather than in the single "providers" implementing this interface.

Return

(array) An array description of a Swagger supported component.

Top ↑

Source

File: src/Tribe/REST/V1/Endpoints/Archive_Category.php

	public function get_documentation() {
		return array(
			'get' => array(
				'parameters' => $this->swaggerize_args( $this->READ_args(), array( 'in' => 'query', 'default' => '' ) ),
				'responses'  => array(
					'200' => array(
						'description' => __( 'Returns all the event categories matching the search criteria', 'the-event-calendar' ),
						'schema'      => array(
							'title' => $this->get_data_key(),
							'type'  => 'array',
							'items' => array( '$ref' => '#/definitions/Term' ),
						),
					),
					'400' => array(
						'description' => __( 'One or more of the specified query variables has a bad format', 'the-events-calendar' ),
					),
					'404' => array(
						'description' => __( 'The requested page was not found.', 'the-events-calendar' ),
					),
				),
			),
		);
	}

Expand full source code Collapse full source code

Top ↑