[DOCS-15216] [Atlas Search] Creating an Atlas Search Index Fails Using the API if a Collection Doesn't Exist Created: 07/Apr/22  Updated: 29/Oct/23  Resolved: 18/Apr/22

Status: Closed
Project: Documentation
Component/s: FTS
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Minor - P4
Reporter: Ronan Merrick Assignee: Kanchana Sekhar
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 1 year, 42 weeks, 5 days ago
Story Points: 2

 Description   

If you try to create an Atlas Search index using the API, it will fail if the collection doesn't exist.

However, this isn't clear from our Documentation.

On the main "Create an Atlas Search Index" page, the prerequisites are listed as:

To create an Atlas Search index, you must have an Atlas cluster with:
 
    MongoDB version 4.2 or higher
    At least one collection

This says at least one collection, but doesn't mention the specific collection.

If you're creating an Atlas Search index through the UI, you can only select an existing collection.

However on the relevant API page, it doesn't mention that the collection must exist.

I'm suggesting:
1. On the main "Create an Atlas Search Index" page, state that the collection must exist
2. On the API page state that although the request may return a status of 200, the index creation will fail if the collection does not exist



 Comments   
Comment by Ronan Merrick [ 15/Apr/22 ]

Thanks kanchana.sekhar@mongodb.com!

Comment by Kanchana Sekhar [ 15/Apr/22 ]

ronan.merrick@mongodb.com Thanks for opening this ticket. Updated the "Create an Atlas Search Index" page, but didn't make changes to the API page because we are replacing all manually written API pages with auto-generated OpenAPI docs shortly.

Comment by Kanchana Sekhar [ 15/Apr/22 ]
Generated at Thu Feb 08 08:12:18 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.