v0.28: Changes to /documents

[guimachiavelli]

Closes #1700

[curquiza]

According to the spec, the fields parameter is now also available for the GET /indexes/:uid/documents/:document_uid route.

[maryamsulemani97]

Looks good! 🦋
A few suggestions:

• Update learn/getting_started/algolia_migration.md line 193: displayedAttributes setting does not impact the displayed fields returned
• I think we should update the get_documents_1 code sample to show how to use the fields parameter
• Add a note that fields values are case-sensitive.

[guimachiavelli]

@maryamsulemani97: thanks for the suggestions. I agree with the second and third, but unless I'm mistaken the attributesToRetrieve mentioned in the line you indicated refers to the search parameter attributesToRetrieve, not /documents's fields.

[curquiza]

🤘

[maryamsulemani97]

unless I'm mistaken the attributesToRetrieve mentioned in the line you indicated refers to the search parameter attributesToRetrieve, not /documents's fields.

Two rows use attributesToRetrieve, lines 182 and 193. I'm assuming 182 refers to the search parameter

[guimachiavelli]

@maryamsulemani97: hmmmm…I'm not sure why it's there two times—could be an error, or that Algolia does not distinguish between things we do (and thus need two separate names). In any case, the line introducing the table reads (emphasis mine):

The below table compares Algolia's API parameters with the equivalent Meilisearch setting or search parameter.

It explicitly states that this concerns settings and search parameters while fields is only concerned with the documents route. The main goal of this update seems to be to further distance /documents from /search— to the point that fields is now completely independent from displayedAttributes.

So I still think that, since the table is about index settings and search parameters, it should not be affected by changes to the /documents route.

[maryamsulemani97]

🥷

[guimachiavelli]

bors merge

[bors]

Build succeeded:

• check-links
• check-style