Security controller documentation #417

benoitvidis · 2019-07-09T08:53:29Z

What does this PR do?

Add documentation for the security controller.

⚠️ Once this PR is merged, the documentation submodule needs to be updated!

Other changes

add a npm run doc command to serve the documentation in development mode
remove unused (for now) dependency from travis file.

codecov · 2019-07-09T09:01:32Z

Codecov Report

Merging #417 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff           @@
##           master    #417   +/-   ##
======================================
  Coverage    96.3%   96.3%           
======================================
  Files          32      32           
  Lines        1517    1517           
======================================
  Hits         1461    1461           
  Misses         56      56

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ec85a14...cd6882f. Read the comment docs.

codecov · 2019-07-09T09:01:32Z

Codecov Report

Merging #417 into master will increase coverage by 0.1%.
The diff coverage is 100%.

@@            Coverage Diff            @@
##           master     #417     +/-   ##
=========================================
+ Coverage    96.3%   96.41%   +0.1%     
=========================================
  Files          32       32             
  Lines        1517     1535     +18     
=========================================
+ Hits         1461     1480     +19     
+ Misses         56       55      -1

Impacted Files	Coverage Δ
src/protocols/http.js	`92.68% <100%> (+0.27%)`	⬆️
src/controllers/bulk.js	`100% <100%> (ø)`	⬆️
src/core/Jwt.js	`100% <100%> (+4.76%)`	⬆️
src/protocols/abstract/common.js	`91.11% <100%> (+2.22%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58d7837...a16558c. Read the comment docs.

Aschen

Congrats !

doc/6/controllers/security/delete-profile/snippets/delete-profile.js

doc/6/controllers/security/delete-credentials/snippets/delete-credentials.js

doc/6/controllers/security/delete-role/snippets/delete-role.js

doc/6/controllers/security/delete-user/index.md

doc/6/controllers/security/update-role-mapping/snippets/update-role-mapping.js

doc/6/controllers/security/update-user-mapping/snippets/update-user-mapping.js

doc/docker-compose.yml

Co-Authored-By: Adrien Maret <[email protected]>

…o/sdk-javascript into kzl-1174-doc-security-controller

codecov-io · 2019-07-22T11:25:39Z

Codecov Report

Merging #417 into master will increase coverage by 0.14%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #417      +/-   ##
==========================================
+ Coverage    96.3%   96.45%   +0.14%     
==========================================
  Files          32       33       +1     
  Lines        1517     1550      +33     
==========================================
+ Hits         1461     1495      +34     
+ Misses         56       55       -1

Impacted Files	Coverage Δ
src/protocols/http.js	`92.68% <100%> (+0.27%)`	⬆️
src/controllers/bulk.js	`100% <100%> (ø)`	⬆️
src/core/Jwt.js	`100% <100%> (+4.76%)`	⬆️
src/protocols/abstract/pendingRequest.js	`100% <100%> (ø)`
src/protocols/abstract/common.js	`91.83% <100%> (+2.94%)`	⬆️
src/protocols/abstract/realtime.js	`100% <100%> (ø)`	⬆️
src/Kuzzle.js	`94.59% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 58d7837...e24a2e5. Read the comment docs.

codecov-io · 2019-07-22T11:25:39Z

Codecov Report

Merging #417 into 6-dev will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            6-dev     #417   +/-   ##
=======================================
  Coverage   96.45%   96.45%           
=======================================
  Files          33       33           
  Lines        1550     1550           
=======================================
  Hits         1495     1495           
  Misses         55       55

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 83a3868...b9fa7ce. Read the comment docs.

scottinet · 2019-07-23T07:44:03Z

doc/6/controllers/security/create-first-admin/index.md

+<br />
+
+```js
+createFirstAdmin(kuid, body, [options]);


The kuid is optional and should be put in the options object

It is not in the sdk and would induce a breaking change.

we should fix our documentation then

doc/6/controllers/security/create-first-admin/index.md

...6/controllers/security/create-or-replace-profile/snippets/create-or-replace-profile.test.yml

doc/6/controllers/security/create-or-replace-role/snippets/create-or-replace-role.test.yml

doc/6/controllers/security/create-profile/snippets/create-profile.test.yml

doc/6/controllers/security/delete-profile/snippets/delete-profile.test.yml

doc/6/controllers/security/delete-role/snippets/delete-role.test.yml

doc/6/controllers/security/delete-user/snippets/delete-user.test.yml

doc/6/controllers/security/get-profile-rights/index.md

doc/6/controllers/security/update-user/index.md

scottinet · 2019-07-23T08:02:42Z

I took the liberty to change the target base from master to 6-dev.

Co-Authored-By: Sébastien Cottinet <[email protected]>

…create-or-replace-profile.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Co-Authored-By: Sébastien Cottinet <[email protected]>

…st.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

…ile.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Co-Authored-By: Sébastien Cottinet <[email protected]>

…ile.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Co-Authored-By: Sébastien Cottinet <[email protected]>

…ate-or-replace-role.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

…ate-restricted-user.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

…st.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Co-Authored-By: Sébastien Cottinet <[email protected]>

…credentials.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

…y-controller

# [6.2.0](https://github.com/kuzzleio/sdk-javascript/releases/tag/6.2.0) (2019-07-31) #### Bug fixes - [ [#428](#428) ] Properly handle boolean flags in HTTP querystrings ([scottinet](https://github.com/scottinet)) - [ [#427](#427) ] Solve promise+event+memory leaks when the network fails ([scottinet](https://github.com/scottinet)) - [ [#424](#424) ] Prevent pending request leak when disconnect the SDK ([Aschen](https://github.com/Aschen)) - [ [#422](#422) ] Fix bug when decoding JWT in browser ([Aschen](https://github.com/Aschen)) - [ [#420](#420) ] Fix http protocol unresolved promise on connection error ([Aschen](https://github.com/Aschen)) #### New features - [ [#419](#419) ] Add bulk:write and bulk:mWrite ([Aschen](https://github.com/Aschen)) #### Enhancements - [ [#421](#421) ] Get api routes from server:publicApi ([Aschen](https://github.com/Aschen)) - [ [#423](#423) ] Emit queryError event on malformed request ([Aschen](https://github.com/Aschen)) - [ [#417](#417) ] Security controller documentation ([benoitvidis](https://github.com/benoitvidis)) ---

benoitvidis added 3 commits July 8, 2019 18:28

security controller

81bb1b1

doc/security - fixes

7177ddf

doc/security - lighten yml test files

cd6882f

benoitvidis added the changelog:enhancements label Jul 9, 2019

Merge branch 'master' into kzl-1174-doc-security-controller

d99807f

Aschen assigned benoitvidis Jul 12, 2019

Aschen suggested changes Jul 12, 2019

View reviewed changes

benoitvidis and others added 2 commits July 15, 2019 14:58

Update doc/6/controllers/security/delete-user/index.md

2a92a0b

Co-Authored-By: Adrien Maret <[email protected]>

Update doc/6/controllers/security/delete-user/index.md

720a654

Co-Authored-By: Adrien Maret <[email protected]>

Aschen approved these changes Jul 18, 2019

View reviewed changes

Aschen added 5 commits July 19, 2019 17:11

Merge branch '6-dev' into kzl-1174-doc-security-controller

a3b0945

Merge branch 'kzl-1174-doc-security-controller' of github.com:kuzzlei…

aab3a84

…o/sdk-javascript into kzl-1174-doc-security-controller

wip

5b04bf3

Merge branch '6-dev' into kzl-1174-doc-security-controller

a16558c

add gem

e24a2e5

Aschen added 3 commits July 22, 2019 13:41

Merge branch '6-dev' into kzl-1174-doc-security-controller

bf07b41

add travis dead links

0d20609

remove deploy

af4ec80

scottinet changed the base branch from master to 6-dev July 23, 2019 08:01

scottinet suggested changes Jul 23, 2019

View reviewed changes

benoitvidis and others added 5 commits July 24, 2019 11:45

Update doc/6/controllers/security/create-first-admin/index.md

e5f31e6

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-or-replace-profile/snippets/…

525c56c

…create-or-replace-profile.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/update-user/index.md

7d2631f

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/get-profile-rights/index.md

9accf63

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/delete-user/snippets/delete-user.te…

1730b35

…st.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

benoitvidis and others added 11 commits July 24, 2019 11:47

Update doc/6/controllers/security/delete-role/snippets/delete-role.te…

e6c64e6

…st.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/delete-profile/snippets/delete-prof…

03756fd

…ile.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-user/index.md

17cdf92

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-profile/snippets/create-prof…

916b230

…ile.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-restricted-user/index.md

b4e8fd2

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-or-replace-role/snippets/cre…

17753c3

…ate-or-replace-role.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-restricted-user/snippets/cre…

fb6c147

…ate-restricted-user.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-role/snippets/create-role.te…

1c080dd

…st.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/create-user/index.md

f0b18ce

Co-Authored-By: Sébastien Cottinet <[email protected]>

Update doc/6/controllers/security/delete-credentials/snippets/delete-…

5607a33

…credentials.test.yml Co-Authored-By: Sébastien Cottinet <[email protected]>

Merge remote-tracking branch 'origin/6-dev' into kzl-1174-doc-securit…

3cafcc2

…y-controller

alexandrebouthinon approved these changes Jul 24, 2019

View reviewed changes

Merge branch '6-dev' into kzl-1174-doc-security-controller

b9fa7ce

scottinet approved these changes Jul 25, 2019

View reviewed changes

scottinet merged commit bace292 into 6-dev Jul 25, 2019

scottinet deleted the kzl-1174-doc-security-controller branch July 25, 2019 09:42

scottinet mentioned this pull request Jul 31, 2019

Release 6.2.0 #434

Merged

Security controller documentation #417

Security controller documentation #417

Uh oh!

Conversation

benoitvidis commented Jul 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

Other changes

Uh oh!

codecov bot commented Jul 9, 2019

Codecov Report

Uh oh!

codecov bot commented Jul 9, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Aschen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov-io commented Jul 22, 2019

Codecov Report

Uh oh!

codecov-io commented Jul 22, 2019 • edited by codecov bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

scottinet Jul 23, 2019

Choose a reason for hiding this comment

Uh oh!

benoitvidis Jul 24, 2019

Choose a reason for hiding this comment

Uh oh!

scottinet Jul 24, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

scottinet commented Jul 23, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

benoitvidis commented Jul 9, 2019 •

edited

Loading

codecov bot commented Jul 9, 2019 •

edited

Loading

codecov-io commented Jul 22, 2019 •

edited by codecov bot

Loading