Search: Move search endpoints to v1

dima koushha · dima koushha · commit b65a16f0d890 · 2026-01-21T12:11:09.000+01:00
- all 4 search endpoints are now available under v1 - v0 search endpoints remain temporarily and will be deprecated in 3 months - update OpenAPI spec to only list v1 routes and bump its version - update the CHANGELOG Bug: T409542 Change-Id: I9fe94371d2b043c7e8e8c8d611088f2e67a43b1f
diff --git a/extension-repo.json b/extension-repo.json
@@ -660,6 +660,26 @@
 			"path": "/wikibase/v0/suggest/properties",
 			"method": "GET",
 			"factory": "Wikibase\\Repo\\Domains\\Search\\RouteHandlers\\PropertyPrefixSearchRouteHandler::factory"
+		},
+		{
+			"path": "/wikibase/v1/search/items",
+			"method": "GET",
+			"factory": "Wikibase\\Repo\\Domains\\Search\\RouteHandlers\\SimpleItemSearchRouteHandler::factory"
+		},
+		{
+			"path": "/wikibase/v1/search/properties",
+			"method": "GET",
+			"factory": "Wikibase\\Repo\\Domains\\Search\\RouteHandlers\\SimplePropertySearchRouteHandler::factory"
+		},
+		{
+			"path": "/wikibase/v1/suggest/items",
+			"method": "GET",
+			"factory": "Wikibase\\Repo\\Domains\\Search\\RouteHandlers\\ItemPrefixSearchRouteHandler::factory"
+		},
+		{
+			"path": "/wikibase/v1/suggest/properties",
+			"method": "GET",
+			"factory": "Wikibase\\Repo\\Domains\\Search\\RouteHandlers\\PropertyPrefixSearchRouteHandler::factory"
 		}
 	],
 	"SpecialPages": {
diff --git a/repo/domains/search/specs/index.fragment.js b/repo/domains/search/specs/index.fragment.js
@@ -15,7 +15,7 @@ const openapi = {
 		}
 	],
 	"paths": {
-		"/v0/search/items": {
+		"/v1/search/items": {
 			"get": {
 				"operationId": "simpleItemSearch",
 				"tags": [ "item search" ],
@@ -35,7 +35,7 @@ const openapi = {
 				}
 			}
 		},
-		"/v0/search/properties": {
+		"/v1/search/properties": {
 			"get": {
 				"operationId": "simplePropertySearch",
 				"tags": [ "property search" ],
@@ -55,7 +55,7 @@ const openapi = {
 				}
 			}
 		},
-		"/v0/suggest/items": {
+		"/v1/suggest/items": {
 			"get": {
 				"operationId": "suggestItems",
 				"tags": [ "item search" ],
@@ -75,7 +75,7 @@ const openapi = {
 				}
 			}
 		},
-		"/v0/suggest/properties": {
+		"/v1/suggest/properties": {
 			"get": {
 				"operationId": "suggestProperties",
 				"tags": [ "property search" ],
diff --git a/repo/domains/search/tests/mocha/api-testing/ItemPrefixSearchTest.js b/repo/domains/search/tests/mocha/api-testing/ItemPrefixSearchTest.js
@@ -14,7 +14,7 @@ async function createItem( item ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/suggest/items' )
+		.withRoute( 'GET', '/v1/suggest/items' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/api-testing/PropertyPrefixSearchTest.js b/repo/domains/search/tests/mocha/api-testing/PropertyPrefixSearchTest.js
@@ -14,7 +14,7 @@ async function createProperty( property ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/suggest/properties' )
+		.withRoute( 'GET', '/v1/suggest/properties' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/api-testing/SimpleItemSearchTest.js b/repo/domains/search/tests/mocha/api-testing/SimpleItemSearchTest.js
@@ -14,7 +14,7 @@ async function createItem( item ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/search/items' )
+		.withRoute( 'GET', '/v1/search/items' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/api-testing/SimplePropertySearchTest.js b/repo/domains/search/tests/mocha/api-testing/SimplePropertySearchTest.js
@@ -14,7 +14,7 @@ async function createProperty( property ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/search/properties' )
+		.withRoute( 'GET', '/v1/search/properties' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/openapi-validation/ItemPrefixSearchTest.js b/repo/domains/search/tests/mocha/openapi-validation/ItemPrefixSearchTest.js
@@ -13,7 +13,7 @@ async function createItem( item ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/suggest/items' )
+		.withRoute( 'GET', '/v1/suggest/items' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/openapi-validation/PropertyPrefixSearchTest.js b/repo/domains/search/tests/mocha/openapi-validation/PropertyPrefixSearchTest.js
@@ -13,7 +13,7 @@ async function createProperty( property ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/suggest/properties' )
+		.withRoute( 'GET', '/v1/suggest/properties' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/openapi-validation/SimpleItemSearchTest.js b/repo/domains/search/tests/mocha/openapi-validation/SimpleItemSearchTest.js
@@ -13,7 +13,7 @@ async function createItem( item ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/search/items' )
+		.withRoute( 'GET', '/v1/search/items' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/domains/search/tests/mocha/openapi-validation/SimplePropertySearchTest.js b/repo/domains/search/tests/mocha/openapi-validation/SimplePropertySearchTest.js
@@ -13,7 +13,7 @@ async function createProperty( property ) {
 
 function newSearchRequest( language, searchTerm ) {
 	return new RequestBuilder()
-		.withRoute( 'GET', '/v0/search/properties' )
+		.withRoute( 'GET', '/v1/search/properties' )
 		.withQueryParam( 'language', language )
 		.withQueryParam( 'q', searchTerm );
 }
diff --git a/repo/rest-api/CHANGELOG.md b/repo/rest-api/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG {#wb_rest_api_changelog}
 
+## Version 1.5
+
+* Wikibase REST API search endpoints v1 released
+
 ## Version 1.4
 
 * Added endpoint `GET /wikibase/v0/suggest/properties` ([T397838](https://phabricator.wikimedia.org/T397838))
diff --git a/repo/rest-api/specs/openapi.base.json b/repo/rest-api/specs/openapi.base.json
@@ -2,7 +2,7 @@
 	"openapi": "3.1.0",
 	"info": {
 		"title": "Wikibase REST API",
-		"version": "1.4",
+		"version": "1.5",
 		"description": "OpenAPI definition of Wikibase REST API",
 		"contact": {
 			"name": "Wikimedia Deutschland - Wikibase Reuse Team",
diff --git a/repo/rest-api/src/openapi.json b/repo/rest-api/src/openapi.json
@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "Wikibase REST API",
-    "version": "1.4",
+    "version": "1.5",
     "description": "OpenAPI definition of Wikibase REST API",
     "contact": {
       "name": "Wikimedia Deutschland - Wikibase Reuse Team",
@@ -32972,7 +32972,7 @@
         }
       }
     },
-    "/v0/search/items": {
+    "/v1/search/items": {
       "get": {
         "operationId": "simpleItemSearch",
         "tags": [
@@ -33205,7 +33205,7 @@
         }
       }
     },
-    "/v0/search/properties": {
+    "/v1/search/properties": {
       "get": {
         "operationId": "simplePropertySearch",
         "tags": [
@@ -33438,7 +33438,7 @@
         }
       }
     },
-    "/v0/suggest/items": {
+    "/v1/suggest/items": {
       "get": {
         "operationId": "suggestItems",
         "tags": [
@@ -33671,7 +33671,7 @@
         }
       }
     },
-    "/v0/suggest/properties": {
+    "/v1/suggest/properties": {
       "get": {
         "operationId": "suggestProperties",
         "tags": [

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ const openapi = {`
`15`	`15`	`}`
`16`	`16`	`],`
`17`	`17`	`"paths": {`
`18`		`- "/v0/search/items": {`
	`18`	`+ "/v1/search/items": {`
`19`	`19`	`"get": {`
`20`	`20`	`"operationId": "simpleItemSearch",`
`21`	`21`	`"tags": [ "item search" ],`
`@@ -35,7 +35,7 @@ const openapi = {`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`	`},`
`38`		`- "/v0/search/properties": {`
	`38`	`+ "/v1/search/properties": {`
`39`	`39`	`"get": {`
`40`	`40`	`"operationId": "simplePropertySearch",`
`41`	`41`	`"tags": [ "property search" ],`
`@@ -55,7 +55,7 @@ const openapi = {`
`55`	`55`	`}`
`56`	`56`	`}`
`57`	`57`	`},`
`58`		`- "/v0/suggest/items": {`
	`58`	`+ "/v1/suggest/items": {`
`59`	`59`	`"get": {`
`60`	`60`	`"operationId": "suggestItems",`
`61`	`61`	`"tags": [ "item search" ],`
`@@ -75,7 +75,7 @@ const openapi = {`
`75`	`75`	`}`
`76`	`76`	`}`
`77`	`77`	`},`
`78`		`- "/v0/suggest/properties": {`
	`78`	`+ "/v1/suggest/properties": {`
`79`	`79`	`"get": {`
`80`	`80`	`"operationId": "suggestProperties",`
`81`	`81`	`"tags": [ "property search" ],`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ async function createItem( item ) {`
`14`	`14`
`15`	`15`	`function newSearchRequest( language, searchTerm ) {`
`16`	`16`	`return new RequestBuilder()`
`17`		`- .withRoute( 'GET', '/v0/suggest/items' )`
	`17`	`+ .withRoute( 'GET', '/v1/suggest/items' )`
`18`	`18`	`.withQueryParam( 'language', language )`
`19`	`19`	`.withQueryParam( 'q', searchTerm );`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ async function createItem( item ) {`
`13`	`13`
`14`	`14`	`function newSearchRequest( language, searchTerm ) {`
`15`	`15`	`return new RequestBuilder()`
`16`		`- .withRoute( 'GET', '/v0/suggest/items' )`
	`16`	`+ .withRoute( 'GET', '/v1/suggest/items' )`
`17`	`17`	`.withQueryParam( 'language', language )`
`18`	`18`	`.withQueryParam( 'q', searchTerm );`
`19`	`19`	`}`