Skip to content
This repository has been archived by the owner on Oct 6, 2021. It is now read-only.

docs: add new API documentation #27

Merged
merged 10 commits into from
Aug 11, 2021

Conversation

asaadam
Copy link
Contributor

@asaadam asaadam commented Aug 9, 2021

Description

Add new API documentation in readme

@netlify
Copy link

netlify bot commented Aug 9, 2021

✔️ Deploy Preview for silacak ready!

🔨 Explore the source changes: 7abe948

🔍 Inspect the deploy log: https://app.netlify.com/sites/silacak/deploys/6113a45c82b5cf0007a6e1a3

😎 Browse the preview: https://deploy-preview-27--silacak.netlify.app

Copy link
Member

@resir014 resir014 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@asaadam If this is going to be long, can we split this into another Markdown document and link to it from the Readme?

Let's create a docs/api-reference.md file and move this entire API docs there.

@resir014 resir014 changed the title add new api docs in readme docs: add new API documentation Aug 9, 2021
@asaadam
Copy link
Contributor Author

asaadam commented Aug 9, 2021

@asaadam If this is going to be long, can we split this into another Markdown document and link to it from the Readme?

Let's create a docs/api-reference.md file and move this entire API docs there.

@asaadam If this is going to be long, can we split this into another Markdown document and link to it from the Readme?

Let's create a docs/api-reference.md file and move this entire API docs there.

it's a good idea.
On it

@ramarahmanda
Copy link
Contributor

Refer to this issue #20

Can you add this curl to api docs?

Check account status

curl 'https://silacak.kemkes.go.id/api/users?fields=displayName%2Cid%2Caccess%2CuserCredentials%5Busername%2Cdisabled%2ClastLogin%2CtwoFA%5D%2CteiSearchOrganisationUnits%5Bid%2Cpath%5D&filter=userCredentials.username:eq:<username>&fields=id' \
  -H 'authority: silacak.kemkes.go.id' \
  -H 'pragma: no-cache' \
  -H 'cache-control: no-cache' \
  -H 'sec-ch-ua: "Chromium";v="92", " Not A;Brand";v="99", "Google Chrome";v="92"' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'authorization: Basic YWRtaW4tcmVnaXN0ZXI6S2Vta2VzMjAyMSUl' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36' \
  -H 'origin: https://reg-silacak.kemkes.go.id' \
  -H 'sec-fetch-site: same-site' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-dest: empty' \
  -H 'referer: https://reg-silacak.kemkes.go.id/' \
  -H 'accept-language: en-US,en;q=0.9' \
  --compressed

Copy link
Member

@resir014 resir014 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly documentation formatting issues. A clean codebase comes with clean documentation too.

docs/api-reference.md Outdated Show resolved Hide resolved
docs/api-reference.md Outdated Show resolved Hide resolved
docs/api-reference.md Outdated Show resolved Hide resolved
docs/api-reference.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@asaadam
Copy link
Contributor Author

asaadam commented Aug 10, 2021

Refer to this issue #20

Can you add this curl to api docs?

Check account status

curl 'https://silacak.kemkes.go.id/api/users?fields=displayName%2Cid%2Caccess%2CuserCredentials%5Busername%2Cdisabled%2ClastLogin%2CtwoFA%5D%2CteiSearchOrganisationUnits%5Bid%2Cpath%5D&filter=userCredentials.username:eq:<username>&fields=id' \
  -H 'authority: silacak.kemkes.go.id' \
  -H 'pragma: no-cache' \
  -H 'cache-control: no-cache' \
  -H 'sec-ch-ua: "Chromium";v="92", " Not A;Brand";v="99", "Google Chrome";v="92"' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'authorization: Basic YWRtaW4tcmVnaXN0ZXI6S2Vta2VzMjAyMSUl' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'user-agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36' \
  -H 'origin: https://reg-silacak.kemkes.go.id' \
  -H 'sec-fetch-site: same-site' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-dest: empty' \
  -H 'referer: https://reg-silacak.kemkes.go.id/' \
  -H 'accept-language: en-US,en;q=0.9' \
  --compressed

just want to make it clear.
so, do we need to add all curl for each endpoint?

@asaadam
Copy link
Contributor Author

asaadam commented Aug 10, 2021

@ramarahmanda please help to check this PR. Thanks

README.md Outdated Show resolved Hide resolved
@ramarahmanda
Copy link
Contributor

@asaadam after formatting issues have been resolved, I think it's good enough. I'll add & improve the information in API after merge. wdyt @zainfathoni @resir014

README.md Outdated Show resolved Hide resolved
Co-authored-by: Resi Respati <resir014@gmail.com>
@asaadam asaadam requested a review from resir014 August 11, 2021 03:15
@asaadam
Copy link
Contributor Author

asaadam commented Aug 11, 2021

hey, sorry I miss understood your comment @ramarahmanda .
Already add curl for check account status.

Copy link
Member

@zainfathoni zainfathoni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 💯

Thanks for working on it, @asaadam! 🙏

@zainfathoni zainfathoni dismissed resir014’s stale review August 11, 2021 10:19

The requested changes have been implemented.

@resir014 resir014 added the automerge To be automatically merged once all checks are passed label Aug 11, 2021
@kodiakhq kodiakhq bot merged commit 7d0e779 into kawalcovid19:main Aug 11, 2021
@asaadam asaadam deleted the readme/add-new-api-docs branch August 11, 2021 14:49
@zainfathoni
Copy link
Member

@all-contributors please add @asaadam for doc.

@allcontributors
Copy link
Contributor

@zainfathoni

I've put up a pull request to add @asaadam! 🎉

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
automerge To be automatically merged once all checks are passed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants