Doc language refinement #72
Conversation
doc-language-refinement Conflicts: src/api-users/dto/api-user.dto.ts
doc-language-refinement Conflicts: src/taxa/taxa.dto.ts
breaking-changes.md
Outdated
| > { | ||
| > "species": true, // Matches taxa that have "species": true | ||
| > "informalTaxonGroups": "MVL.1", // Matches taxa with informalTaxonGoup MVL.1 | ||
| > "informalTaxonGroups": "MVL.1,!MVL.2", // Matches taxa with informalTaxonGoup MVL.1 but not MVL.2 |
There was a problem hiding this comment.
Should be ["MVL.1" ,"!MVL.2"]
breaking-changes.md
Outdated
| * Aggregate queries are separated to their own endpoints (`/aggregate`) | ||
| * Old filter parameter names are no longer supported. Use the actual property names from the model. For example `informalGroupFilters` -> `informalTaxonGroups` | ||
| * Name fields ("vernacularName" etc) are served also as multi-lang ("vernacularNameMultiLang"), so the translations can be shown even though `lang` param isn't `multi` | ||
| * All query parameters used for filtering are now moved to the request body, which must be named `filters`. |
There was a problem hiding this comment.
The "filters" IS the body. By stating 'The body is called "filters"', I meant that when this documentation talks about "filters" or a "filter", it refers to a property in the body.
Maybe just leave out the whole sentence, since the example later explains it maybe better?
There was a problem hiding this comment.
Original text was
"All query parameters that affect filtering are moved to the request body. The body is called "filters". Filtering can be now done by any property."
I interpreted that to mean the request must have a multipart body where the body part is named "filters".
Is it the intention of the original phrasing that the body will be later be called "filters" in this document?
There was a problem hiding this comment.
I made changes and dropped the 'filters' entirely
There was a problem hiding this comment.
Is it the intention of the original phrasing that the body will be later be called "filters" in this document?
Yes
No description provided.