[#8] Create User Documentation and add a figure of users table by vdennis · Pull Request #19 · cdcgi/user-service

vdennis · 2020-12-04T04:45:23Z

Init User Documentation

jacky-htg

please resolve my comments below. thanks.

jacky-htg · 2020-12-04T05:17:46Z

+--- | --- | ---
+name | string | dennis 
+username | string | vdennis 
+password | string | cdcgi2020 


POST /users will be call by admin right?
it's need no password in the request payload. prefer generate random password and sent to users's email.

jacky-htg · 2020-12-04T05:27:27Z

+#### Validation
+- name: required and not empty
+- username: required and not empty
+- password: required and not empty and password score > 75


no password required

jacky-htg · 2020-12-04T11:03:22Z

+{
+ "name": "dennis",
+ "username": "vdennis",
+ "password": "Cdcgi2020!"


no password required

jacky-htg · 2020-12-04T11:04:33Z

+{
+ "name": "dennis",
+ "username": "vdennis",
+ "password": "Cdcgi2020!",


no password required. better to generate random password for the first time, because the user will be create by admin, not by user self with registration api.

jacky-htg · 2020-12-04T11:04:54Z

+{
+ "name": "dennis",
+ "username": "vdennis",
+ "password": "Cdcgi2020!",


remove password

) * [#3] Update Regions Documentation and add a figure of regions table * [#3] Update Region Documentation based on review * [#3] Update Region Documentation based on 2nd review * [#3] add region code must be unique and remove the last line that does not need comma * [#3] Update region-layer * [#3] Rename regions.png to region-layer.png * [#3] Remove company_code and kunci from regions table

jacky-htg · 2020-12-07T07:23:29Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "1"


better using int type
"type_akses": 1

jacky-htg · 2020-12-07T07:23:44Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "1",


jacky-htg · 2020-12-07T07:23:55Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "1",


jacky-htg · 2020-12-07T07:24:04Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "2"


jacky-htg · 2020-12-07T07:24:12Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "2",


jacky-htg · 2020-12-07T07:24:50Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "3",


jacky-htg · 2020-12-07T07:24:59Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "4",


jacky-htg · 2020-12-07T07:25:06Z

+ "name": "dennis",
+ "username": "vdennis",
+ "email": "vdennis@cdc.id",
+ "type_akses": "4",


jacky-htg · 2020-12-07T07:25:18Z

+ "name": "dennis",
+ "username": "vdennis", 
+ "email": "vdennis@cdc.id", 
+ "type_akses": "1",


jacky-htg · 2020-12-07T07:29:07Z

+ "name": "dennis",
+ "username": "vdennis", 
+ "email": "vdennis@cdc.id", 
+ "type_akses": "2",


jacky-htg · 2020-12-10T13:25:21Z

+ "status_code": "CDC-201",
+ "status_message": "Created",
+ "data": {
+ "id":"1",


jacky-htg · 2020-12-10T13:26:11Z

+ "id":"1",
+ "name" : "dennis",
+ "username" : "vdennis", 
+ "password" : "7f2994ecd8c1498cd0661589df5051f096fe1aca", 


remove password from response

jacky-htg · 2020-12-10T13:29:39Z

+- super user access
+- name: required and not empty
+- username: required and not empty
+- email: required and not empty


validate email using filter_var

jacky-htg · 2020-12-10T13:48:29Z

+ "status_code": "CDC-200",
+ "status_message": "OK",
+ "data": {
+ "id":"1",


jacky-htg · 2020-12-10T13:48:40Z

+ "id":"1",
+ "name": "dennis", 
+ "username": "vdennis", 
+ "password": "7f2994ecd8c1498cd0661589df5051f096fe1aca", 


remove password

jacky-htg · 2020-12-10T13:48:52Z

+ "status_code": "CDC-200",
+ "status_message": "OK",
+ "data": {
+ "id":"1",


jacky-htg · 2020-12-10T13:49:03Z

+ "id":"1",
+ "name": "dennis", 
+ "username": "vdennis", 
+ "password": "7f2994ecd8c1498cd0661589df5051f096fe1aca", 


remove password

jacky-htg · 2020-12-16T01:18:35Z

+```
+{
+ "status_code": "cdc-400",
+ "status_message": "company_id is required",


in edit mode, if there is no company_id in request payload, you can use the existing data. its mean, the company_id is not changed.

jacky-htg · 2020-12-16T01:21:30Z

+```
+{
+ "status_code": "cdc-400",
+ "status_message": "region_id is required",


in edit mode, if there is no region_id, you can use the existing data. it's mean the region_id is not changed. But if any update of company_id, you should revalidate : "whether the existing region_id is still belongs to company_id"?

jacky-htg · 2020-12-16T01:23:20Z

+```
+{
+ "status_code": "cdc-400",
+ "status_message": "branch_id is required",


in edit mode, if there is no branch_id, you can use the existing data. it's mean the branch_id is not changed. But if any update of company_id, you should revalidate : "whether the existing branch_id is still belongs to company_id"?
also you should revalidate if any change region_id : "whether the existing branch_id is still belongs to region_id"?

jacky-htg · 2020-12-16T01:25:08Z

+```
+{
+ "status_code": "cdc-400",
+ "status_message": "kios_id is required",


in edit mode, if there is no kios_id, you can use the existing data. it's mean the kios_id is not changed. But if any update of company_id, you should revalidate : "whether the existing kios_id is still belongs to company_id"?
and you should revalidate if any change region_id : "whether the existing kios_id is still belongs to region_id"?
also you should revalidate if any change branch_id : "whether the existing kios_id is still belongs to branch_id"?

jacky-htg · 2020-12-16T01:28:26Z

+Accept | application/json
+Email | admin@cdc.id
+
+### Request Param


### Param Query

[#8] Create User Documentation and add a figure of users table
4edbb6a

vdennis requested review from a team, AhmadGozali19, Jonsen-92, dzakitajudin, fakhri007, ferrystiawan, jacky-htg, juniarthaim, lukman134, msyuniarto and wahablie December 4, 2020 04:45

jacky-htg requested changes Dec 4, 2020
View reviewed changes

[#8] Update User Documentation based on review
088314d

vdennis requested a review from jacky-htg December 4, 2020 08:19

jacky-htg requested changes Dec 4, 2020
View reviewed changes

msyuniartoand others added 6 commits December 6, 2020 13:58

[#8] Create User Documentation and add a figure of users table
fff126a

[#8] Update User Documentation based on review
506c5c8

[#8] Update User Add Documentation
55fee72

[#8] Update User Add Documentation
5abba09

[#8] Update User Add Documentation
0066ac5

vdennis requested a review from jacky-htg December 7, 2020 02:08

jacky-htg requested changes Dec 7, 2020
View reviewed changes

vdennis added 2 commits December 9, 2020 13:00

[#8] Update User Edit Documentation
fc4ba4d

[#8] Update type akses and add positive case edit password
828b7ae

vdennis requested a review from jacky-htg December 9, 2020 06:08

vdennis added 2 commits December 9, 2020 13:12

[#8] Update status code when not found 400 to 404
bbdfa32

[#8] Update view and delete user documentation
73227f7

jacky-htg requested changes Dec 10, 2020
View reviewed changes

[#8] Update User documentation, view all user, and database image
62a58e2

vdennis requested a review from jacky-htg December 15, 2020 09:14

jacky-htg requested changes Dec 16, 2020
View reviewed changes

[#8] update user documentation on edit
3c9b3c2

vdennis requested a review from jacky-htg December 18, 2020 02:30

jacky-htg approved these changes Dec 18, 2020
View reviewed changes

msyuniarto approved these changes Dec 18, 2020
View reviewed changes

AhmadGozali19 approved these changes Dec 18, 2020
View reviewed changes

vdennis merged commit 6517688 into mainDec 18, 2020

vdennis deleted the feature/user branch December 18, 2020 06:41

Uh oh!

Conversation

vdennis commented Dec 4, 2020

Uh oh!

jacky-htg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants