Skip to content

REST API: Fix schema for app_id property in application passwords endpoints #8282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Sukhendu2002 wants to merge 4 commits into from
Closed

REST API: Fix schema for app_id property in application passwords endpoints #8282

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
97c6eba
Fix schema for app_id property in application passwords and also add …
Sukhendu2002 Feb 10, 2025
ae43252
Fix PHPCS Errors
Sukhendu2002 Feb 10, 2025
038d186
Merge branch 'trunk' into fix/53692-app-id-schema-empty-string
johnbillion Jul 2, 2025
56904b1
Update the generated schema.
johnbillion Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion src/wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,16 @@ public function get_item_schema() {
'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',
'oneOf' => array(
array(
'type' => 'string',
'format' => 'uuid',
),
array(
'type' => 'string',
'enum' => array( '' ),
),
),
'context' => array( 'view', 'edit', 'embed' ),
),
'name' => array(
Expand Down
61 changes: 61 additions & 0 deletions tests/phpunit/tests/rest-api/rest-application-passwords-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -847,6 +847,67 @@ public function test_prepare_item() {
$this->check_response( $prepared->get_data(), $item );
}

/**
* @ticket 53692
*/
public function test_app_id_schema() {
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/users/me/application-passwords' );
$response = rest_get_server()->dispatch( $request );
$data = $response->get_data();
$properties = $data['schema']['properties'];

$this->assertArrayHasKey( 'app_id', $properties );
$this->assertSame( 'string', $properties['app_id']['type'] );
$this->assertCount( 2, $properties['app_id']['oneOf'] );

$this->assertSame( 'string', $properties['app_id']['oneOf'][0]['type'] );
$this->assertSame( 'uuid', $properties['app_id']['oneOf'][0]['format'] );

$this->assertSame( 'string', $properties['app_id']['oneOf'][1]['type'] );
$this->assertSame( array( '' ), $properties['app_id']['oneOf'][1]['enum'] );
}

/**
* @ticket 53692
*/
public function test_create_item_with_empty_app_id() {
wp_set_current_user( self::$admin );

$request = new WP_REST_Request( 'POST', '/wp/v2/users/' . self::$admin . '/application-passwords' );
$request->set_body_params(
array(
'name' => 'Test',
'app_id' => '',
)
);

$response = rest_get_server()->dispatch( $request );
$this->assertSame( 201, $response->get_status() );
$data = $response->get_data();
$this->assertSame( '', $data['app_id'] );
}

/**
* @ticket 53692
*/
public function test_create_item_with_uuid_app_id() {
wp_set_current_user( self::$admin );

$uuid = wp_generate_uuid4();
$request = new WP_REST_Request( 'POST', '/wp/v2/users/' . self::$admin . '/application-passwords' );
$request->set_body_params(
array(
'name' => 'Test',
'app_id' => $uuid,
)
);

$response = rest_get_server()->dispatch( $request );
$this->assertSame( 201, $response->get_status() );
$data = $response->get_data();
$this->assertSame( $uuid, $data['app_id'] );
}

/**
* Checks the password response matches the expected format.
*
Expand Down
26 changes: 24 additions & 2 deletions tests/qunit/fixtures/wp-api-generated.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10053,7 +10053,18 @@ mockedApiResponse.Schema = {
"app_id": {
"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",
"oneOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string",
"enum": [
""
]
}
],
"required": false
},
"name": {
Expand Down Expand Up @@ -10137,7 +10148,18 @@ mockedApiResponse.Schema = {
"app_id": {
"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",
"oneOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "string",
"enum": [
""
]
}
],
"required": false
},
"name": {
Expand Down
Loading