Merge "REST: Replace label/description/aliases-not-defined"

wikimedia · Sep 5, 2024 · d2980ec · d2980ec
2 parents 0973358 + e968d82
commit d2980ec
Show file tree

Hide file tree

Showing 37 changed files with 85 additions and 206 deletions.
diff --git a/repo/rest-api/specs/global/examples.json b/repo/rest-api/specs/global/examples.json
@@ -155,42 +155,6 @@
 			}
 		}
 	},
-	"ItemLabelNotDefinedExample": {
-		"value": {
-			"code": "label-not-defined",
-			"message": "Item with the ID {item_id} does not have a label in the language: {language_code}"
-		}
-	},
-	"PropertyLabelNotDefinedExample": {
-		"value": {
-			"code": "label-not-defined",
-			"message": "Property with the ID {property_id} does not have a label in the language: {language_code}"
-		}
-	},
-	"ItemDescriptionNotDefinedExample": {
-		"value": {
-			"code": "description-not-defined",
-			"message": "Item with the ID {item_id} does not have a description in the language: {language_code}"
-		}
-	},
-	"PropertyDescriptionNotDefinedExample": {
-		"value": {
-			"code": "description-not-defined",
-			"message": "Property with the ID {property_id} does not have a description in the language: {language_code}"
-		}
-	},
-	"ItemAliasesNotDefinedExample": {
-		"value": {
-			"code": "aliases-not-defined",
-			"message": "Item with the ID {item_id} does not have aliases in the language: {language_code}"
-		}
-	},
-	"PropertyAliasesNotDefinedExample": {
-		"value": {
-			"code": "aliases-not-defined",
-			"message": "Property with the ID {property_id} does not have aliases in the language: {language_code}"
-		}
-	},
 	"PatchedInvalidSitelinkTypeExample": {
 		"value": {
 			"code": "patched-invalid-sitelink-type'",

diff --git a/repo/rest-api/specs/global/responses.json b/repo/rest-api/specs/global/responses.json
@@ -253,8 +253,8 @@
 					"item-not-found": {
 						"$ref": "./examples.json#/ItemNotFoundExample"
 					},
-					"label-not-defined": {
-						"$ref": "./examples.json#/ItemLabelNotDefinedExample"
+					"resource-not-found": {
+						"$ref": "./examples.json#/ResourceNotFoundExample"
 					}
 				}
 			}
@@ -277,8 +277,8 @@
 					"property-not-found": {
 						"$ref": "./examples.json#/PropertyNotFoundExample"
 					},
-					"label-not-defined": {
-						"$ref": "./examples.json#/PropertyLabelNotDefinedExample"
+					"resource-not-found": {
+						"$ref": "./examples.json#/ResourceNotFoundExample"
 					}
 				}
 			}
@@ -301,8 +301,8 @@
 					"item-not-found": {
 						"$ref": "./examples.json#/ItemNotFoundExample"
 					},
-					"aliases-not-defined": {
-						"$ref": "./examples.json#/ItemAliasesNotDefinedExample"
+					"resource-not-found": {
+						"$ref": "./examples.json#/ResourceNotFoundExample"
 					}
 				}
 			}
@@ -325,8 +325,8 @@
 					"property-not-found": {
 						"$ref": "./examples.json#/PropertyNotFoundExample"
 					},
-					"aliases-not-defined": {
-						"$ref": "./examples.json#/PropertyAliasesNotDefinedExample"
+					"resource-not-found": {
+						"$ref": "./examples.json#/ResourceNotFoundExample"
 					}
 				}
 			}
@@ -349,8 +349,8 @@
 					"item-not-found": {
 						"$ref": "./examples.json#/ItemNotFoundExample"
 					},
-					"description-not-defined": {
-						"$ref": "./examples.json#/ItemDescriptionNotDefinedExample"
+					"resource-not-found": {
+						"$ref": "./examples.json#/ResourceNotFoundExample"
 					}
 				}
 			}
@@ -373,8 +373,8 @@
 					"property-not-found": {
 						"$ref": "./examples.json#/PropertyNotFoundExample"
 					},
-					"description-not-defined": {
-						"$ref": "./examples.json#/PropertyDescriptionNotDefinedExample"
+					"resource-not-found": {
+						"$ref": "./examples.json#/ResourceNotFoundExample"
 					}
 				}
 			}

diff --git a/repo/rest-api/src/Application/UseCases/GetItemAliasesInLanguage/GetItemAliasesInLanguage.php b/repo/rest-api/src/Application/UseCases/GetItemAliasesInLanguage/GetItemAliasesInLanguage.php
@@ -40,10 +40,7 @@ public function execute( GetItemAliasesInLanguageRequest $request ): GetItemAlia
 
 		$aliases = $this->itemAliasesInLanguageRetriever->getAliasesInLanguage( $itemId, $languageCode );
 		if ( !$aliases ) {
-			throw new UseCaseError(
-				UseCaseError::ALIASES_NOT_DEFINED,
-				"Item with the ID $itemId does not have aliases in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'aliases' );
 		}
 
 		return new GetItemAliasesInLanguageResponse( $aliases, $lastModified, $revisionId );

diff --git a/repo/rest-api/src/Application/UseCases/GetItemDescription/GetItemDescription.php b/repo/rest-api/src/Application/UseCases/GetItemDescription/GetItemDescription.php
@@ -39,10 +39,7 @@ public function execute( GetItemDescriptionRequest $request ): GetItemDescriptio
 
 		$description = $this->itemDescriptionRetriever->getDescription( $itemId, $languageCode );
 		if ( $description === null ) {
-			throw new UseCaseError(
-				UseCaseError::DESCRIPTION_NOT_DEFINED,
-				"Item with the ID {$itemId} does not have a description in the language: {$languageCode}"
-			);
+			throw UseCaseError::newResourceNotFound( 'description' );
 		}
 
 		return new GetItemDescriptionResponse(

diff --git a/repo/rest-api/src/Application/UseCases/GetItemLabel/GetItemLabel.php b/repo/rest-api/src/Application/UseCases/GetItemLabel/GetItemLabel.php
@@ -39,10 +39,7 @@ public function execute( GetItemLabelRequest $request ): GetItemLabelResponse {
 
 		$label = $this->itemLabelRetriever->getLabel( $itemId, $languageCode );
 		if ( !$label ) {
-			throw new UseCaseError(
-				UseCaseError::LABEL_NOT_DEFINED,
-				"Item with the ID {$itemId->getSerialization()} does not have a label in the language: {$languageCode}"
-			);
+			throw UseCaseError::newResourceNotFound( 'label' );
 		}
 
 		return new GetItemLabelResponse(

diff --git a/...pi/src/Application/UseCases/GetPropertyAliasesInLanguage/GetPropertyAliasesInLanguage.php b/...pi/src/Application/UseCases/GetPropertyAliasesInLanguage/GetPropertyAliasesInLanguage.php
@@ -37,10 +37,7 @@ public function execute( GetPropertyAliasesInLanguageRequest $request ): GetProp
 
 		$aliases = $this->propertyAliasesRetriever->getAliasesInLanguage( $propertyId, $languageCode );
 		if ( !$aliases ) {
-			throw new UseCaseError(
-				UseCaseError::ALIASES_NOT_DEFINED,
-				"Property with the ID $propertyId does not have aliases in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'aliases' );
 		}
 
 		return new GetPropertyAliasesInLanguageResponse( $aliases, $lastModified, $revisionId );

diff --git a/repo/rest-api/src/Application/UseCases/GetPropertyDescription/GetPropertyDescription.php b/repo/rest-api/src/Application/UseCases/GetPropertyDescription/GetPropertyDescription.php
@@ -37,10 +37,7 @@ public function execute( GetPropertyDescriptionRequest $request ): GetPropertyDe
 
 		$description = $this->descriptionRetriever->getDescription( $propertyId, $languageCode );
 		if ( !$description ) {
-			throw new UseCaseError(
-				UseCaseError::DESCRIPTION_NOT_DEFINED,
-				"Property with the ID {$propertyId->getSerialization()} does not have a description in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'description' );
 		}
 
 		return new GetPropertyDescriptionResponse( $description, $lastModified, $revisionId );

diff --git a/repo/rest-api/src/Application/UseCases/GetPropertyLabel/GetPropertyLabel.php b/repo/rest-api/src/Application/UseCases/GetPropertyLabel/GetPropertyLabel.php
@@ -37,10 +37,7 @@ public function execute( GetPropertyLabelRequest $request ): GetPropertyLabelRes
 
 		$label = $this->labelRetriever->getLabel( $propertyId, $languageCode );
 		if ( !$label ) {
-			throw new UseCaseError(
-				UseCaseError::LABEL_NOT_DEFINED,
-				"Property with the ID {$propertyId->getSerialization()} does not have a label in the language: {$languageCode}"
-			);
+			throw UseCaseError::newResourceNotFound( 'label' );
 		}
 
 		return new GetPropertyLabelResponse( $label, $lastModified, $revisionId );

diff --git a/repo/rest-api/src/Application/UseCases/RemoveItemDescription/RemoveItemDescription.php b/repo/rest-api/src/Application/UseCases/RemoveItemDescription/RemoveItemDescription.php
@@ -54,10 +54,7 @@ public function execute( RemoveItemDescriptionRequest $request ): void {
 		try {
 			$description = $item->getDescriptions()->getByLanguage( $languageCode );
 		} catch ( OutOfBoundsException $e ) {
-			throw new UseCaseError(
-				UseCaseError::DESCRIPTION_NOT_DEFINED,
-				"Item with the ID $itemId does not have a description in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'description' );
 		}
 		$item->getDescriptions()->removeByLanguage( $languageCode );
 

diff --git a/repo/rest-api/src/Application/UseCases/RemoveItemLabel/RemoveItemLabel.php b/repo/rest-api/src/Application/UseCases/RemoveItemLabel/RemoveItemLabel.php
@@ -51,10 +51,7 @@ public function execute( RemoveItemLabelRequest $request ): void {
 		try {
 			$label = $item->getLabels()->getByLanguage( $languageCode );
 		} catch ( OutOfBoundsException $e ) {
-			throw new UseCaseError(
-				UseCaseError::LABEL_NOT_DEFINED,
-				"Item with the ID $itemId does not have a label in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'label' );
 		}
 
 		$item->getLabels()->removeByLanguage( $languageCode );

diff --git a/...rest-api/src/Application/UseCases/RemovePropertyDescription/RemovePropertyDescription.php b/...rest-api/src/Application/UseCases/RemovePropertyDescription/RemovePropertyDescription.php
@@ -54,10 +54,7 @@ public function execute( RemovePropertyDescriptionRequest $request ): void {
 		try {
 			$description = $property->getDescriptions()->getByLanguage( $languageCode );
 		} catch ( OutOfBoundsException $e ) {
-			throw new UseCaseError(
-				UseCaseError::DESCRIPTION_NOT_DEFINED,
-				"Property with the ID $propertyId does not have a description in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'description' );
 		}
 
 		$property->getDescriptions()->removeByLanguage( $languageCode );

diff --git a/repo/rest-api/src/Application/UseCases/RemovePropertyLabel/RemovePropertyLabel.php b/repo/rest-api/src/Application/UseCases/RemovePropertyLabel/RemovePropertyLabel.php
@@ -53,10 +53,7 @@ public function execute( RemovePropertyLabelRequest $request ): void {
 		try {
 			$label = $property->getLabels()->getByLanguage( $languageCode );
 		} catch ( OutOfBoundsException $e ) {
-			throw new UseCaseError(
-				UseCaseError::LABEL_NOT_DEFINED,
-				"Property with the ID $propertyId does not have a label in the language: $languageCode"
-			);
+			throw UseCaseError::newResourceNotFound( 'label' );
 		}
 
 		$property->getLabels()->removeByLanguage( $languageCode );

diff --git a/repo/rest-api/src/Application/UseCases/UseCaseError.php b/repo/rest-api/src/Application/UseCases/UseCaseError.php
@@ -9,18 +9,15 @@
  */
 class UseCaseError extends UseCaseException {
 
-	public const ALIASES_NOT_DEFINED = 'aliases-not-defined';
 	public const CANNOT_MODIFY_READ_ONLY_VALUE = 'cannot-modify-read-only-value';
 	public const DATA_POLICY_VIOLATION = 'data-policy-violation';
-	public const DESCRIPTION_NOT_DEFINED = 'description-not-defined';
 	public const INVALID_KEY = 'invalid-key';
 	public const INVALID_PATH_PARAMETER = 'invalid-path-parameter';
 	public const INVALID_QUERY_PARAMETER = 'invalid-query-parameter';
 	public const INVALID_VALUE = 'invalid-value';
 	public const ITEM_NOT_FOUND = 'item-not-found';
 	public const ITEM_REDIRECTED = 'redirected-item';
 	public const ITEM_STATEMENT_ID_MISMATCH = 'item-statement-id-mismatch';
-	public const LABEL_NOT_DEFINED = 'label-not-defined';
 	public const MISSING_FIELD = 'missing-field';
 	public const PATCH_RESULT_INVALID_KEY = 'patch-result-invalid-key';
 	public const PATCH_RESULT_INVALID_VALUE = 'patch-result-invalid-value';
@@ -78,18 +75,15 @@ class UseCaseError extends UseCaseException {
 	public const CONTEXT_VIOLATION_CONTEXT = 'violation_context';
 
 	public const EXPECTED_CONTEXT_KEYS = [
-		self::ALIASES_NOT_DEFINED => [],
 		self::CANNOT_MODIFY_READ_ONLY_VALUE => [ self::CONTEXT_PATH ],
 		self::DATA_POLICY_VIOLATION => [ self::CONTEXT_VIOLATION, self::CONTEXT_VIOLATION_CONTEXT ],
-		self::DESCRIPTION_NOT_DEFINED => [],
 		self::INVALID_KEY => [ self::CONTEXT_PATH, self::CONTEXT_KEY ],
 		self::INVALID_PATH_PARAMETER => [ self::CONTEXT_PARAMETER ],
 		self::INVALID_QUERY_PARAMETER => [ self::CONTEXT_PARAMETER ],
 		self::INVALID_VALUE => [ self::CONTEXT_PATH ],
 		self::ITEM_NOT_FOUND => [],
 		self::ITEM_REDIRECTED => [ self::CONTEXT_REDIRECT_TARGET ],
 		self::ITEM_STATEMENT_ID_MISMATCH => [ self::CONTEXT_ITEM_ID, self::CONTEXT_STATEMENT_ID ],
-		self::LABEL_NOT_DEFINED => [],
 		self::MISSING_FIELD => [ self::CONTEXT_PATH, self::CONTEXT_FIELD ],
 		self::PATCH_RESULT_VALUE_TOO_LONG => [ self::CONTEXT_PATH, self::CONTEXT_LIMIT ],
 		self::PATCH_RESULT_INVALID_KEY => [ self::CONTEXT_PATH, self::CONTEXT_KEY ],

diff --git a/repo/rest-api/src/RouteHandlers/ErrorResponseToHttpStatus.php b/repo/rest-api/src/RouteHandlers/ErrorResponseToHttpStatus.php
@@ -28,10 +28,7 @@ class ErrorResponseToHttpStatus {
 		UseCaseError::PERMISSION_DENIED => 403,
 
 		// 404 errors:
-		UseCaseError::ALIASES_NOT_DEFINED => 404,
-		UseCaseError::DESCRIPTION_NOT_DEFINED => 404,
 		UseCaseError::ITEM_NOT_FOUND => 404,
-		UseCaseError::LABEL_NOT_DEFINED => 404,
 		UseCaseError::PROPERTY_NOT_FOUND => 404,
 		UseCaseError::RESOURCE_NOT_FOUND => 404,
 		UseCaseError::STATEMENT_NOT_FOUND => 404,

diff --git a/repo/rest-api/src/RouteHandlers/openapi.json b/repo/rest-api/src/RouteHandlers/openapi.json
@@ -3976,8 +3976,8 @@
               "item-not-found": {
                 "$ref": "#/components/examples/ItemNotFoundExample"
               },
-              "label-not-defined": {
-                "$ref": "#/components/examples/ItemLabelNotDefinedExample"
+              "resource-not-found": {
+                "$ref": "#/components/examples/ResourceNotFoundExample"
               }
             }
           }
@@ -4002,8 +4002,8 @@
               "property-not-found": {
                 "$ref": "#/components/examples/PropertyNotFoundExample"
               },
-              "label-not-defined": {
-                "$ref": "#/components/examples/PropertyLabelNotDefinedExample"
+              "resource-not-found": {
+                "$ref": "#/components/examples/ResourceNotFoundExample"
               }
             }
           }
@@ -4028,8 +4028,8 @@
               "item-not-found": {
                 "$ref": "#/components/examples/ItemNotFoundExample"
               },
-              "aliases-not-defined": {
-                "$ref": "#/components/examples/ItemAliasesNotDefinedExample"
+              "resource-not-found": {
+                "$ref": "#/components/examples/ResourceNotFoundExample"
               }
             }
           }
@@ -4054,8 +4054,8 @@
               "property-not-found": {
                 "$ref": "#/components/examples/PropertyNotFoundExample"
               },
-              "aliases-not-defined": {
-                "$ref": "#/components/examples/PropertyAliasesNotDefinedExample"
+              "resource-not-found": {
+                "$ref": "#/components/examples/ResourceNotFoundExample"
               }
             }
           }
@@ -4080,8 +4080,8 @@
               "item-not-found": {
                 "$ref": "#/components/examples/ItemNotFoundExample"
               },
-              "description-not-defined": {
-                "$ref": "#/components/examples/ItemDescriptionNotDefinedExample"
+              "resource-not-found": {
+                "$ref": "#/components/examples/ResourceNotFoundExample"
               }
             }
           }
@@ -4106,8 +4106,8 @@
               "property-not-found": {
                 "$ref": "#/components/examples/PropertyNotFoundExample"
               },
-              "description-not-defined": {
-                "$ref": "#/components/examples/PropertyDescriptionNotDefinedExample"
+              "resource-not-found": {
+                "$ref": "#/components/examples/ResourceNotFoundExample"
               }
             }
           }
@@ -7131,42 +7131,6 @@
           }
         }
       },
-      "ItemLabelNotDefinedExample": {
-        "value": {
-          "code": "label-not-defined",
-          "message": "Item with the ID {item_id} does not have a label in the language: {language_code}"
-        }
-      },
-      "PropertyLabelNotDefinedExample": {
-        "value": {
-          "code": "label-not-defined",
-          "message": "Property with the ID {property_id} does not have a label in the language: {language_code}"
-        }
-      },
-      "ItemDescriptionNotDefinedExample": {
-        "value": {
-          "code": "description-not-defined",
-          "message": "Item with the ID {item_id} does not have a description in the language: {language_code}"
-        }
-      },
-      "PropertyDescriptionNotDefinedExample": {
-        "value": {
-          "code": "description-not-defined",
-          "message": "Property with the ID {property_id} does not have a description in the language: {language_code}"
-        }
-      },
-      "ItemAliasesNotDefinedExample": {
-        "value": {
-          "code": "aliases-not-defined",
-          "message": "Item with the ID {item_id} does not have aliases in the language: {language_code}"
-        }
-      },
-      "PropertyAliasesNotDefinedExample": {
-        "value": {
-          "code": "aliases-not-defined",
-          "message": "Property with the ID {property_id} does not have aliases in the language: {language_code}"
-        }
-      },
       "PatchedInvalidSitelinkTypeExample": {
         "value": {
           "code": "patched-invalid-sitelink-type'",

diff --git a/repo/rest-api/tests/mocha/api-testing/GetItemAliasesInLanguageTest.js b/repo/rest-api/tests/mocha/api-testing/GetItemAliasesInLanguageTest.js
@@ -93,7 +93,7 @@ describe( newGetItemAliasesInLanguageRequestBuilder().getRouteDescription(), ()
 			.assertValidRequest()
 			.makeRequest();
 
-		assertValidError( response, 404, 'aliases-not-defined' );
-		assert.include( response.body.message, languageCode );
+		assertValidError( response, 404, 'resource-not-found', { resource_type: 'aliases' } );
+		assert.strictEqual( response.body.message, 'The requested resource does not exist' );
 	} );
 } );