Merge "Search: Add prefix search OAS definitions"

Author: jenkins-bot

repo/domains/search/specs/global/responses.js

@@ -83,5 +83,29 @@ module.exports = {
 				}
 			}
 		}
-	}
+	},
+	"SuggestItemSuccess": {
+		"description": "A list of search results",
+		"content": {
+			"application/json": {
+				"schema": schemaParts.SearchItemResultList,
+				"example": {
+					"results": [
+						{
+							"id": "Q456",
+							"display-label": { "language": "en", "value": "drinking water" },
+							"description": { "language": "en", "value": "water safe for consumption" },
+							"match": { "type": "alias", "language": "en", "text": "potable water" }
+						},
+						{
+							"id": "Q123",
+							"display-label": { "language": "en", "value": "potato" },
+							"description": { "language": "en", "value": "staple food" },
+							"match": { "type": "label", "language": "en", "text": "potato" }
+						}
+					]
+				}
+			}
+		}
+	},
 };

repo/domains/search/specs/index.fragment.js

@@ -59,6 +59,27 @@ const openapi = {
 					"400": { "$ref": "#/components/responses/BadRequest" }
 				}
 			}
+		},
+		"/v0/suggest/items": {
+			"get": {
+				"operationId": "simpleItemSuggest",
+				"tags": [ "item search" ],
+				"summary": "[WIP] Simple Item search by prefix, for labels and aliases",
+				"description": "This endpoint is currently in development and is not recommended for production use.",
+				"parameters": [
+					{
+						...parameters.SearchQuery,
+						"example": "pota"
+					},
+					{ "$ref": "#/components/parameters/SearchLanguage" },
+					{ "$ref": "#/components/parameters/Limit" },
+					{ "$ref": "#/components/parameters/Offset" },
+				],
+				"responses": {
+					"200": { "$ref": "#/components/responses/SuggestItemSuccess" },
+					"400": { "$ref": "#/components/responses/BadRequest" }
+				}
+			}
 		}
 	},
 	"components": {