Updated_Events::get_documentation()


Source

File: src/Common/Event_Automator/Zapier/REST/V1/Endpoints/Updated_Events.php

	public function get_documentation() {
		$POST_defaults = [
			'in'      => 'formData',
			'default' => '',
			'type'    => 'string',
		];
		$post_args     = array_merge( $this->READ_args() );

		return [
			'post' => [
				'consumes'   => [ 'application/x-www-form-urlencoded' ],
				'parameters' => $this->swaggerize_args( $post_args, $POST_defaults ),
				'responses'  => [
					'201' => [
						'description' => _x( 'Returns successful checking of the updated event queue.', 'Description for the Zapier Updated Event REST endpoint on a successful return.', 'event-automator' ),
						'schema'      => [
							'$ref' => '#/definitions/Zapier',
						],
					],
					'400' => [
						'description' => _x( 'A required parameter is missing or an input parameter is in the wrong format', 'Description for the Zapier Updated Event REST endpoint missing a required parameter.', 'event-automator' ),
					],
				],
			],
		];
	}