[#5] Update Companies Documentation and add a figure of companies table #18

AhmadGozali19 · 2020-12-04T04:36:47Z

No description provided.

jacky-htg

please resolve my comments below. thanks.

doc/companies.md

jacky-htg · 2020-12-04T05:38:10Z

doc/companies.md

+HTTP Code | Status | Description
+--- | --- | ---
+400 | Bad Request | Bad request payload  
+404 | Not Found | User not found in database  


jacky-htg · 2020-12-04T05:39:55Z

doc/companies.md

+### Request Payloads
+Name | Type | Example Value
+--- | --- | ---
+id | string | 5


remove id. use from path.

jacky-htg · 2020-12-04T05:40:09Z

doc/companies.md

+kota | string | JAKARTA
+```
+{
+    "id":"5",


jacky-htg · 2020-12-04T05:40:34Z

doc/companies.md

+HTTP Code | Status | Description
+--- | --- | ---
+400 | Bad Request | Bad request payload  
+404 | Not Found | User not found in database  


Company not found

jacky-htg · 2020-12-04T05:49:41Z

doc/companies.md

+}
+```
+
+#### Case : Negative Case 3


invalid case

jacky-htg · 2020-12-04T05:50:24Z

doc/companies.md

+}
+```
+
+#### Case : Negative Case 4


invalid case. but we need scenario case for company not found. grab id from path.

jacky-htg · 2020-12-04T05:50:38Z

doc/companies.md

+
+#### Case : Positive Case
+
+Request Payload :


no request payload

doc/companies.md

jacky-htg · 2020-12-08T01:08:51Z

doc/companies.md

+400 | Bad Request | Bad request payload  
+404 | Not Found | User not found in database  
+500 | Internal Server Error | some un-handle error in server
+200 | OK | OK


remove 200 OK since we use 201 Created

jacky-htg · 2020-12-08T01:10:08Z

doc/companies.md

+}
+```
+
+Response HTTP Status Code : 200


jacky-htg · 2020-12-08T01:11:54Z

doc/companies.md

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


id --> uuid, not number string

jacky-htg · 2020-12-08T01:12:17Z

doc/companies.md

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


id --> uuid, not number string

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

doc/companies.md

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


id --> uuid, not number string

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

doc/companies.md

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


id --> uuid, not number string

jacky-htg · 2020-12-08T01:17:00Z

doc/companies.md

+400 | Bad Request | Bad request payload  
+404 | Not Found | User not found in database  
+500 | Internal Server Error | some un-handle error in server
+200 | OK | OK


remove 200 OK since we use 204 no content

jacky-htg · 2020-12-08T01:18:03Z

doc/companies.md

+```
+
+```
+{


remove all response payload. 204 no content it;s mean really no content ion body response.

doc/companies.md

jacky-htg · 2020-12-08T08:12:17Z

doc/companies.md

+}
+```
+
+#### Case : Negative Case 2


remove this scenario because it's invalid case. no param request, it's mean no data changed.

jacky-htg

add endpoint for get list of companies with pagination. GET /companies

Param Query

Name	Example Value	Description
search	jawara	keyword for search companies. default is empty.
page	1	current page. default 1.
limit	20	limit data in 1 pages. default 20.
order	companies.name	order of list. default companies.id
sort	asc	sort of list. option value is asc

Example URL : GET /companies?search=jawara&order=companies.name

Response Payload

{
    "status_code": "cdc-200",
    "status_message": "sucsess",
    "data": {
        "companies": [
            {
                "id":"5e8d6470-f654-24c8-93ac-332e6c3dra2e",
                "company_code": "TC",
                "name": "Test Company",
                "address": "JL. Test Company",
                "npwp": "123",
                "nomor_kukuh": "123",
                "tgl_kukuh": "2020-12-08",
                "phone_num": "021",
                "fax_num": "021",
                "seri_pajak": "12",
                "kota": "JAKARTA"
            }
        ],
        "pagination": {
            "search": "",
            "page": 1,
            "limit": 20,
            "order": "companies.name",
            "sort": "desc",
            "count": 100
        }
    }
}

there is no 404 response. If result is empty, response status code is 200, with body response payload :

{
    "status_code": "cdc-200",
    "status_message": "sucsess",
    "data": {
        "companies": [],
        "pagination": {
            "search": "",
            "page": 1,
            "limit": 20,
            "order": "companies.name",
            "sort": "desc",
            "count": 0
        }
    }
}

jacky-htg · 2020-12-10T16:38:42Z

doc/companies.md

+[View](#view) | GET | /companies/:id | View Data Companies
+[Edit](#edit) | PUT | /companies/:id | Edit Data Companies
+[Delete](#delete) | DELETE | /companies/:id | Delete Data Companies
+


add endpoint for get list of companies with pagination. GET /companies

Param Query

Name Example Value Description

search jawara keyword for search companies. default is empty.

page 1 current page. default 1.

limit 20 limit data in 1 pages. default 20.

order companies.name order of list. default companies.id

sort asc sort of list. option value is asc

Example URL : GET /companies?search=jawara&order=companies.name

Response Payload

{ "status_code": "cdc-200", "status_message": "sucsess", "data": { "companies": [ { "id":"5e8d6470-f654-24c8-93ac-332e6c3dra2e", "company_code": "TC", "name": "Test Company", "address": "JL. Test Company", "npwp": "123", "nomor_kukuh": "123", "tgl_kukuh": "2020-12-08", "phone_num": "021", "fax_num": "021", "seri_pajak": "12", "kota": "JAKARTA" } ], "pagination": { "search": "", "page": 1, "limit": 20, "order": "companies.name", "sort": "desc", "count": 100 } } }

there is no 404 response. If result is empty, response status code is 200, with body response payload :

{ "status_code": "cdc-200", "status_message": "sucsess", "data": { "companies": [], "pagination": { "search": "", "page": 1, "limit": 20, "order": "companies.name", "sort": "desc", "count": 0 } } }

…arameters

jacky-htg · 2020-12-14T04:17:11Z

doc/companies.md

+    "status_message": "OK",
+    "data": {
+      "companies" : [
+        "id":"5e8d6470-f654-24c8-93ac-332e6c3dra2e",


doc/companies.md

… using {}

jacky-htg

please resolve your code on file doc/companies.md line 900.
companies are array of company object. please wrap the company data using {}

[#5] Update Companies Documentation and add a figure of companies table

be85153

AhmadGozali19 requested review from jacky-htg, vdennis, fakhri007, wahablie, msyuniarto and lukman134 December 4, 2020 04:36

jacky-htg requested changes Dec 4, 2020

View reviewed changes

[#5] update review documentation and add view API

45ccdfe

AhmadGozali19 requested a review from jacky-htg December 7, 2020 08:58

jacky-htg requested changes Dec 8, 2020

View reviewed changes

AhmadGozali19 added 2 commits December 8, 2020 09:24

[#5] update review documentation and update remove field kunci companies

2966830

[#5] remove field kunci table companies

c2bb9f3

AhmadGozali19 requested a review from jacky-htg December 8, 2020 02:31

msyuniarto requested changes Dec 8, 2020

View reviewed changes

[#5] improvement review documentation

c10244e

AhmadGozali19 requested a review from msyuniarto December 8, 2020 06:10

msyuniarto requested changes Dec 8, 2020

View reviewed changes

doc/companies.md Outdated Show resolved Hide resolved

jacky-htg requested changes Dec 8, 2020

View reviewed changes

[#5] improvement review documentation

8e63f33

AhmadGozali19 requested review from jacky-htg and msyuniarto December 8, 2020 08:22

msyuniarto approved these changes Dec 8, 2020

View reviewed changes

jacky-htg requested changes Dec 10, 2020

View reviewed changes

[#5] documentation update add view list for get list companies with p…

98f60ab

…arameters

AhmadGozali19 requested a review from jacky-htg December 13, 2020 04:53

jacky-htg reviewed Dec 14, 2020

View reviewed changes

[#5] improvement array of company object. wrap array the company data…

b43072e

… using {}

AhmadGozali19 requested a review from jacky-htg December 14, 2020 08:35

jacky-htg requested changes Dec 15, 2020

View reviewed changes

[#5] improvement line 900. wrap the company data

ecd0252

AhmadGozali19 requested a review from jacky-htg December 15, 2020 03:44

jacky-htg approved these changes Dec 15, 2020

View reviewed changes

vdennis approved these changes Dec 15, 2020

View reviewed changes

jacky-htg merged commit fe53eb8 into main Dec 17, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#5] Update Companies Documentation and add a figure of companies table #18

[#5] Update Companies Documentation and add a figure of companies table #18

AhmadGozali19 commented Dec 4, 2020

jacky-htg left a comment

jacky-htg Dec 4, 2020

jacky-htg Dec 4, 2020

jacky-htg Dec 4, 2020

jacky-htg Dec 4, 2020

jacky-htg Dec 4, 2020

jacky-htg Dec 4, 2020

jacky-htg Dec 4, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg Dec 8, 2020

jacky-htg left a comment

jacky-htg Dec 10, 2020

jacky-htg Dec 14, 2020

jacky-htg left a comment

+              ```
+              ```
+              {

[#5] Update Companies Documentation and add a figure of companies table #18

[#5] Update Companies Documentation and add a figure of companies table #18

Conversation

AhmadGozali19 commented Dec 4, 2020

jacky-htg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jacky-htg left a comment

Choose a reason for hiding this comment

Param Query

Response Payload

Choose a reason for hiding this comment

Param Query

Response Payload

Choose a reason for hiding this comment

jacky-htg left a comment

Choose a reason for hiding this comment