diff --git a/api-specs/api/resources/customers.raml b/api-specs/api/resources/customers.raml index 312e2a275..4f1582ff1 100644 --- a/api-specs/api/resources/customers.raml +++ b/api-specs/api/resources/customers.raml @@ -239,7 +239,8 @@ post: displayName: Search Customers securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }] description: | - A [SearchNotReady](ctp:api:type:SearchNotReadyError) error is returned if the indexing is in progress or the feature is deactivated. If deactivated, you can [reactivate](/../api/projects/customer-search#reactivate) it. + If the initial indexing is in progress or the feature is inactive, a [SearchNotReady](ctp:api:type:SearchNotReadyError) error is returned. + If inactive, you can [reactivate](/../api/projects/customer-search#reactivate) it. body: application/json: type: CustomerSearchRequest @@ -252,7 +253,7 @@ post: securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }] description: | Checks whether a search index of Customers exists for a Project. - If an index exists, a `200 OK` is returned; otherwise, a `409 Conflict`. + Returns a `200 OK` if an index exists; otherwise, returns a `409 Conflict`. responses: 200: description: A search index exists and the [Search Customers](ctp:api:endpoint:/{projectKey}/customers/search:POST) endpoint is fully operational. diff --git a/api-specs/api/resources/products.raml b/api-specs/api/resources/products.raml index 5ec569c07..0d69f4c4f 100644 --- a/api-specs/api/resources/products.raml +++ b/api-specs/api/resources/products.raml @@ -260,6 +260,9 @@ post: post: displayName: Search Products securedBy: [oauth_2_0: { scopes: ['view_published_products:{projectKey}'] }] + description: | + If the indexing is in progress or the feature is inactive, an [ObjectNotFound](ctp:api:type:ObjectNotFoundError) error is returned. + If inactive, you can [reactivate](/../api/projects/product-search#activation-of-the-feature) it. body: application/json: type: ProductSearchRequest diff --git a/api-specs/api/types/error/ObjectNotFoundError.raml b/api-specs/api/types/error/ObjectNotFoundError.raml index 4c4c6a392..377a29eb4 100644 --- a/api-specs/api/types/error/ObjectNotFoundError.raml +++ b/api-specs/api/types/error/ObjectNotFoundError.raml @@ -4,11 +4,13 @@ type: ErrorObject displayName: ObjectNotFoundError discriminatorValue: ObjectNotFound description: | - Returned when the requested resource was not found. + Returned if the requested resource was not found or the Product Search index is [inactive](/../api/projects/product-search#activation-of-the-feature). properties: code: type: string message: type: string description: | - `"A $resourceType with identifier $id was unexpectedly not found."` + `"A $resourceType with identifier $id was unexpectedly not found."` or + + `"No index found for project"` diff --git a/api-specs/api/types/error/graphql/GraphQLObjectNotFoundError.raml b/api-specs/api/types/error/graphql/GraphQLObjectNotFoundError.raml index 8b3f68b8b..f4eba88ed 100644 --- a/api-specs/api/types/error/graphql/GraphQLObjectNotFoundError.raml +++ b/api-specs/api/types/error/graphql/GraphQLObjectNotFoundError.raml @@ -4,7 +4,7 @@ type: GraphQLErrorObject displayName: GraphQLObjectNotFoundError discriminatorValue: ObjectNotFound description: | - Returned when the requested resource was not found. + Returned if the requested resource was not found or the Product Search index is [inactive](/../api/projects/product-search#activation-of-the-feature). properties: code: type: string