Various feedback on SDK JS V2 documentation

[ScreamZ]

Hello,

I list some errors on documentation v2, could you please reply in this thread when you fixed with the value fixed for each ticket. I need it for kuzzleio/sdk-javascript#319.

I want also tell that returns type are not consistent, sometimes we have some fields, sometimes not. This is also highly coupled with Elastic Search, which will need a lot of refactor once you'll release another database driver.

You can use checkmark for each ticket progression.

Regards

Issues

• https://docs-v2.kuzzle.io/sdk-reference/js/6/index/delete/ return type incoherent with sample
• https://docs-v2.kuzzle.io/sdk-reference/js/6/index/refresh/ failed or fail ?
• https://docs-v2.kuzzle.io/sdk-reference/js/6/auth/get-my-rights/ Little graphical bug on An `array<object containing: and Rights (`allowed
• https://docs-v2.kuzzle.io/sdk-reference/js/6/auth/login/ Error on type for credentials params. Also login (strategy, credentials, expiresIn) should be login (strategy, [credentials], [expiresIn]) because seems optional ?
• https://docs-v2.kuzzle.io/sdk-reference/js/6/auth/validate-my-credentials/ credentials param type and also [ ] if optional ?
• https://docs-v2.kuzzle.io/sdk-reference/js/6/ms link broken
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/create/ create (index, collection, mapping = null, [options]) mapping should be [mapping = null]
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/get-specifications/ Doc format broken + example of specification ?
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/search-specifications/ link to https://docs-v2.kuzzle.io/sdk-reference/js/6/essentials/search-result is broken.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/search-specifications/ scroll type must be string not number ("2d", "3w")
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/update-specifications/ doc broken - https://docs-v2.kuzzle.io/validation-reference/schema BROKEN LINK
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/create/ Semantic error, id is optional but not in [ ] and optional param is before required param, which is a semantic error.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/createOrReplace/ same semantic error with id.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/delete/ « Optional document id » no thats not true.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/deleteByQuery/ Query is optional in a deleteByQuery ?
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/mDelete/ incomplete resolve function with types.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/mGet/ Is it always resolving with an object with key hits containing array of docs and total ? (not written in resolve paragraph but only in example.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/mUpdate/ Error while copy pasting method name.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/replace/ No CSS on that page, also here return type give result key but create and createOrReplace return _source
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/search/ SearchResultObject not defined.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/realtime/unsubscribe/ No resolve arguments doc.
• https://docs-v2.kuzzle.io/sdk-reference/js/6/server/now/ Timestamp returned is string or number ?
• https://docs-v2.kuzzle.io/sdk-reference/js/6/essentials/ Doc missing

[Aschen]

Thanks for your feedback! It is very much appreciated :)

[Aschen]

• https://docs-v2.kuzzle.io/sdk-reference/js/6/index/delete/ return type incoherent with sample No return
• https://docs-v2.kuzzle.io/sdk-reference/js/6/index/refresh/ failed or fail ? failed
• https://docs-v2.kuzzle.io/sdk-reference/js/6/auth/get-my-rights/ Little graphical bug on An `array<object containing: and Rights (`allowed done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/auth/login/ Error on type for credentials params. Also login (strategy, credentials, expiresIn) should be login (strategy, [credentials], [expiresIn]) because seems optional ? optional
• https://docs-v2.kuzzle.io/sdk-reference/js/6/auth/validate-my-credentials/ credentials param type and also [ ] if optional ? optional
• https://docs-v2.kuzzle.io/sdk-reference/js/6/ms link broken done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/create/ create (index, collection, mapping = null, [options]) mapping should be [mapping = null] done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/get-specifications/ Doc format broken + example of specification ? done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/search-specifications/ link to https://docs-v2.kuzzle.io/sdk-reference/js/6/essentials/search-result is broken. done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/search-specifications/ scroll type must be string not number ("2d", "3w") done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/collection/update-specifications/ doc broken - https://docs-v2.kuzzle.io/validation-reference/schema BROKEN LINK done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/create/ Semantic error, id is optional but not in [ ] and optional param is before required param, which is a semantic error. id and option are last params
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/createOrReplace/ same semantic error with id. id is not optional
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/delete/ « Optional document id » no thats not true. done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/deleteByQuery/ Query is optional in a deleteByQuery ? yes, no query match all documents
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/mDelete/ incomplete resolve function with types. resolve to an object, see doc
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/mGet/ Is it always resolving with an object with key hits containing array of docs and total ? (not written in resolve paragraph but only in example. doc updated
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/mUpdate/ Error while copy pasting method name. done
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/replace/ No CSS on that page, also here return type give result key but create and createOrReplace return _source have _source property who contain the document
• https://docs-v2.kuzzle.io/sdk-reference/js/6/document/search/ SearchResultObject not defined. link fixed
• https://docs-v2.kuzzle.io/sdk-reference/js/6/realtime/unsubscribe/ No resolve arguments doc. resolve if success
• https://docs-v2.kuzzle.io/sdk-reference/js/6/server/now/ Timestamp returned is string or number ? number
• https://docs-v2.kuzzle.io/sdk-reference/js/6/essentials/ Doc missing deleted