WP_REST_Application_Passwords_Controller::get_item_schema() │ public │ WP 5.6.0

Retrieves the application password's schema, conforming to JSON Schema.

Method of the class: WP_REST_Application_Passwords_Controller{}

No Hooks.

Return

Array. Item schema data.

Usage

$WP_REST_Application_Passwords_Controller = new WP_REST_Application_Passwords_Controller();
$WP_REST_Application_Passwords_Controller->get_item_schema();

Changelog

WP_REST_Application_Passwords_Controller::get_item_schema() WP REST Application Passwords Controller::get item schema code ^{WP 6.4.1}

public function get_item_schema() {
	if ( $this->schema ) {
		return $this->add_additional_fields_schema( $this->schema );
	}

	$this->schema = array(
		'$schema'    => 'http://json-schema.org/draft-04/schema#',
		'title'      => 'application-password',
		'type'       => 'object',
		'properties' => array(
			'uuid'      => array(
				'description' => __( 'The unique identifier for the application password.' ),
				'type'        => 'string',
				'format'      => 'uuid',
				'context'     => array( 'view', 'edit', 'embed' ),
				'readonly'    => true,
			),
			'app_id'    => array(
				'description' => __( 'A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace.' ),
				'type'        => 'string',
				'format'      => 'uuid',
				'context'     => array( 'view', 'edit', 'embed' ),
			),
			'name'      => array(
				'description' => __( 'The name of the application password.' ),
				'type'        => 'string',
				'required'    => true,
				'context'     => array( 'view', 'edit', 'embed' ),
				'minLength'   => 1,
				'pattern'     => '.*\S.*',
			),
			'password'  => array(
				'description' => __( 'The generated password. Only available after adding an application.' ),
				'type'        => 'string',
				'context'     => array( 'edit' ),
				'readonly'    => true,
			),
			'created'   => array(
				'description' => __( 'The GMT date the application password was created.' ),
				'type'        => 'string',
				'format'      => 'date-time',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'last_used' => array(
				'description' => __( 'The GMT date the application password was last used.' ),
				'type'        => array( 'string', 'null' ),
				'format'      => 'date-time',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
			'last_ip'   => array(
				'description' => __( 'The IP address the application password was last used by.' ),
				'type'        => array( 'string', 'null' ),
				'format'      => 'ip',
				'context'     => array( 'view', 'edit' ),
				'readonly'    => true,
			),
		),
	);

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