Skip to content

Commit 4025ec4

Browse files
committed
Updated API from documentation release
1 parent 9066fb1 commit 4025ec4

File tree

4 files changed

+11
-5
lines changed

4 files changed

+11
-5
lines changed

api-specs/api/resources/customers.raml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,8 @@ post:
239239
displayName: Search Customers
240240
securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }]
241241
description: |
242-
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.
242+
If the initial indexing is in progress or the feature is inactive, a [SearchNotReady](ctp:api:type:SearchNotReadyError) error is returned.
243+
If inactive, you can [reactivate](/../api/projects/customer-search#reactivate) it.
243244
body:
244245
application/json:
245246
type: CustomerSearchRequest
@@ -252,7 +253,7 @@ post:
252253
securedBy: [oauth_2_0: { scopes: ['view_customers:{projectKey}'] }]
253254
description: |
254255
Checks whether a search index of Customers exists for a Project.
255-
If an index exists, a `200 OK` is returned; otherwise, a `409 Conflict`.
256+
Returns a `200 OK` if an index exists; otherwise, returns a `409 Conflict`.
256257
responses:
257258
200:
258259
description: A search index exists and the [Search Customers](ctp:api:endpoint:/{projectKey}/customers/search:POST) endpoint is fully operational.

api-specs/api/resources/products.raml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,9 @@ post:
260260
post:
261261
displayName: Search Products
262262
securedBy: [oauth_2_0: { scopes: ['view_published_products:{projectKey}'] }]
263+
description: |
264+
If the indexing is in progress or the feature is inactive, an [ObjectNotFound](ctp:api:type:ObjectNotFoundError) error is returned.
265+
If inactive, you can [reactivate](/../api/projects/product-search#activation-of-the-feature) it.
263266
body:
264267
application/json:
265268
type: ProductSearchRequest

api-specs/api/types/error/ObjectNotFoundError.raml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ type: ErrorObject
44
displayName: ObjectNotFoundError
55
discriminatorValue: ObjectNotFound
66
description: |
7-
Returned when the requested resource was not found.
7+
Returned if the requested resource was not found or the Product Search index is [inactive](/../api/projects/product-search#activation-of-the-feature).
88
properties:
99
code:
1010
type: string
1111
message:
1212
type: string
1313
description: |
14-
`"A $resourceType with identifier $id was unexpectedly not found."`
14+
`"A $resourceType with identifier $id was unexpectedly not found."` or
15+
16+
`"No index found for project"`

api-specs/api/types/error/graphql/GraphQLObjectNotFoundError.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ type: GraphQLErrorObject
44
displayName: GraphQLObjectNotFoundError
55
discriminatorValue: ObjectNotFound
66
description: |
7-
Returned when the requested resource was not found.
7+
Returned if the requested resource was not found or the Product Search index is [inactive](/../api/projects/product-search#activation-of-the-feature).
88
properties:
99
code:
1010
type: string

0 commit comments

Comments
 (0)