Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

auth:checkToken: remove an erroneous and confusing precision #274

Merged
merged 4 commits into from
Apr 10, 2019

Conversation

scottinet
Copy link
Contributor

@scottinet scottinet commented Apr 5, 2019

Description

In our auth:checkToken documentation there is the following sentence: This API route does not require the caller to be logged in.

After thinking hard about it I think I understand what it means: "you don't need to have an authentication token active to verify a token". Which should be obvious, since we require the token to be checked to be set in the body part of the request.

Moreover, even with a more explicit comment, that would still be confusing, because Kuzzle doesn't give any special treatment to this API route: administrators can remove rights to it to the anonymous role, meaning that you cannot use it without being logged in (or at all). That may sounds weird, but that's how it is.

Other changes

  • The CI was still referring to the documentation-v2 repository name, so I fixed that.
  • The lint check wasn't executed in the CI, which is a mistake
  • Fixed a linter error to make the CI pass

@scottinet scottinet self-assigned this Apr 5, 2019
@kuzzle
Copy link
Contributor

kuzzle commented Apr 5, 2019

Snippets tests reports

SDK Version Tests overview
v6 ✔️
v5 ✔️
v1 ✔️
v1 ✔️
v1 ✔️
v1 ✔️

@etrousset etrousset merged commit 877be13 into master Apr 10, 2019
@Aschen Aschen mentioned this pull request May 29, 2019
This was referenced Jun 12, 2019
xbill82 added a commit that referenced this pull request Jun 13, 2019
# [3.0.0](https://github.com/kuzzleio/documentation/releases/tag/3.0.0) (2019-06-12)


#### Bug fixes

- [ [#298](#298) ] Fix bulk import return   ([Aschen](https://github.com/Aschen))
- [ [#325](#325) ] Adapt legacy redirection   ([Aschen](https://github.com/Aschen))
- [ [#322](#322) ] Fix remaining dead links and add check_link to CI   ([Aschen](https://github.com/Aschen))
- [ [#304](#304) ] Fix sdk js tests   ([benoitvidis](https://github.com/benoitvidis))

#### New features

- [ [#299](#299) ] Documentation for wildcard events   ([thomasarbona](https://github.com/thomasarbona))
- [ [#321](#321) ] Add guide about secrets management with the Vault   ([Aschen](https://github.com/Aschen))
- [ [#300](#300) ] Add page about bulk:write and bulk:mwrite   ([Aschen](https://github.com/Aschen))

#### Enhancements

- [ [#327](#327) ] SPA mode   ([xbill82](https://github.com/xbill82))
- [ [#324](#324) ] Update Redis version   ([Aschen](https://github.com/Aschen))
- [ [#316](#316) ] Sdks authenticated connected props   ([Aschen](https://github.com/Aschen))
- [ [#317](#317) ] Add new way for updateSpecifications & validateSpecifications   ([thomasarbona](https://github.com/thomasarbona))
- [ [#296](#296) ] Rewrite the Realtime guide   ([Aschen](https://github.com/Aschen))
- [ [#301](#301) ] Deprecate realtime join   ([Aschen](https://github.com/Aschen))
- [ [#291](#291) ] Getting started React + improve snippetManager   ([thomasarbona](https://github.com/thomasarbona))
- [ [#294](#294) ] Add s3 plugin   ([Aschen](https://github.com/Aschen))
- [ [#292](#292) ] Add since   ([Aschen](https://github.com/Aschen))
- [ [#276](#276) ] [KZL-907] Getting started dev plugin   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#284](#284) ] Extending the JS SDK with controllers   ([Aschen](https://github.com/Aschen))
- [ [#271](#271) ] Add documentation page about mappings   ([Aschen](https://github.com/Aschen))

#### Others

- [ [#314](#314) ] Add a clustering guide   ([scottinet](https://github.com/scottinet))
- [ [#319](#319) ] Getting-started-sdk-JS6-architecture   ([berthieresteban](https://github.com/berthieresteban))
- [ [#311](#311) ] Add PDF sending example for Request.setResult   ([Aschen](https://github.com/Aschen))
- [ [#315](#315) ] Normalize directories and generate redirections   ([Aschen](https://github.com/Aschen))
- [ [#309](#309) ] Port #284 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#308](#308) ] Port #283 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#307](#307) ] Port #282 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#306](#306) ] Port #280 to 3-dev   ([berthieresteban](https://github.com/berthieresteban))
- [ [#312](#312) ] Port 278 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#310](#310) ] Port #277 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#305](#305) ] Port #275 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#303](#303) ] Port #274 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#302](#302) ] Port #271 to 3-dev   ([Aschen](https://github.com/Aschen))
- [ [#313](#313) ] Port #266 to 3-dev   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#290](#290) ] [KZL-1050] Role template example in the documentation   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#293](#293) ] [KZL-1036] Add available plugins   ([Yoann-Abbes](https://github.com/Yoann-Abbes))
- [ [#286](#286) ] Embedded protocols   ([benoitvidis](https://github.com/benoitvidis))
---
@scottinet scottinet deleted the fix-checktoken-documentation branch July 23, 2019 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants