Skip to content

Commit 8adf955

Browse files
harshii0509rohit-setuaditya-67riyasuntwalriyasuntwal
authored
Updating bridge v2 docs (#239)
* update api reference and insights list * revert insights list changes * Add v1 Insights documentation * added tags feature for AA framework (#238) * added tags feature for AA framework * removed list for single element in error messages column under data fetch API * Update consent object --------- Co-authored-by: riyasuntwal <riyasuntwal@Setus-MacBook-Pro.local> Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> * Added v2 docs * Added assets to bridge v2 docs * Updated assets in overview & configure page * Remove unused APIs * Added customer-account-closed error code for biller (#242) * Added customer-account-closed error code * fixed Alignment issue --------- Co-authored-by: shanmuga3 <shanmuga@setu.co> * FIP Health API changes (#243) * Update request body for create fi data block * Docs/adding tags to api reference and updating info (#247) * Added-API-reference-support-for-tags-in-consent * updated-tags-related-info --------- Co-authored-by: riyasuntwal <riyasuntwal@Setus-MacBook-Pro.local> * Data 1822 (#250) * initial commit for docs * add esign template api reference * add description for the pdf templating api reference * Update menu items --------- Co-authored-by: rahul roy <rahul@setu.co> Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> * Remove OKYC documentation * docs(DATA-1850): add estamp count API to docs (#246) Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> * fix heading, fix the response of the get api (#252) * fix heading, fix the response of the get api * Update heading --------- Co-authored-by: rahul roy <rahul@setu.co> Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> * added-enableAdditionalPhoneNumber-config-in-consent-journey (#253) Co-authored-by: riyasuntwal <riyasuntwal@Setus-MacBook-Pro.local> * added details of name match data in api response and eSign notification response as an optional feature (#254) * added details of name match data in api response and esign notification response as an optional feature * formatted code block with <CodeBlockWithCopy> tag * Remove extra characters --------- Co-authored-by: Piyush Das <piyushdas@Setus-MacBook-Pro.local> Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> * Added create signature request with estamp and minor modifications in estamp (#255) Co-authored-by: Harsh Lohiya <harshlohiya@Setus-MacBook-Pro-3.local> * add encryption addon doc (#249) * add encryption addon doc * Add menu items --------- Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> * Update README.md * Create README.md * Update README.md * Update sessionId to stringified integer in webhooks examples * Update redirects --------- Co-authored-by: rohit-setu <129901428+rohit-setu@users.noreply.github.com> Co-authored-by: Aditya Gannavarapu <adityagannavarapu.67@gmail.com> Co-authored-by: riyasuntwal <riya@setu.co> Co-authored-by: riyasuntwal <riyasuntwal@Setus-MacBook-Pro.local> Co-authored-by: Gnanesh <gnanesh@setu.co> Co-authored-by: Shanmuga Priyan T <138189691+Shanu06github@users.noreply.github.com> Co-authored-by: shanmuga3 <shanmuga@setu.co> Co-authored-by: arpit-patel7 <155535828+arpit-patel7@users.noreply.github.com> Co-authored-by: Rahul Kumar Roy <oreanroy@gmail.com> Co-authored-by: rahul roy <rahul@setu.co> Co-authored-by: VarunSonava <varun@setu.co> Co-authored-by: daspiyush <69394733+daspiyush@users.noreply.github.com> Co-authored-by: Piyush Das <piyushdas@Setus-MacBook-Pro.local> Co-authored-by: Harsh Lohiya <96139663+HarshLohiya@users.noreply.github.com> Co-authored-by: Harsh Lohiya <harshlohiya@Setus-MacBook-Pro-3.local> Co-authored-by: prabal-tikeriha-setu <prabal@setu.co>
1 parent 2515885 commit 8adf955

File tree

72 files changed

+10375
-11751
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

72 files changed

+10375
-11751
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,10 @@ You can now use Setu's pre-built editor to preview API references. [Visit the pr
6565

6666
> Currently this only works for JSON files. Support for YAML is WIP and should be available soon.
6767
68+
# API playground
69+
70+
You can find API playground mock payload for [Setu API playground](https://api-playground.setu.co) in `/api-playground` folder. Please refer to this [detailed guide](./api-playground/README.md) on how to update the API playground mock request payloads
71+
6872
# Versioning
6973

7074
To add versions to any product in our docs, these steps need to be followed:

api-playground/README.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# API playground
2+
3+
This repo consists information of all the products and thier mock payloads to be rendered in API playground.
4+
5+
API references are pulled from the `api-references` folder.
6+
7+
`products.json` contains all the products that are available in API playground.
8+
9+
## Repo structure of `json` folder
10+
11+
- Each category is a folder with products as sub-folders and JSON files inside product folders.
12+
- All files are JSON and they are named after the `operationID` of each request in API reference.
13+
- In every JSON file, you'll find
14+
- `parameters` object containing, header, query, path etc
15+
- `body` object which is the example body of that request

api-playground/json/data/auto-okyc/CreateanAUTO_OKYCRequest.json

-18
This file was deleted.

api-playground/json/data/auto-okyc/GetdetailsofanAUTO_OKYCRequest.json

-20
This file was deleted.

api-playground/json/data/auto-okyc/[APIonly]CompleteAUTO_OKYCRequest.json

-24
This file was deleted.

api-playground/json/data/auto-okyc/[APIonly]VerifyAUTO_OKYCRequest.json

-23
This file was deleted.

api-playground/json/data/okyc/CreateanOKYCRequest.json

-18
This file was deleted.

api-playground/json/data/okyc/GetdetailsofanOKYCRequest.json

-23
This file was deleted.

api-playground/json/data/okyc/[APIonly]CompleteOKYCRequest.json

-25
This file was deleted.

api-playground/json/data/okyc/[APIonly]InitiateOKYCRequest.json

-20
This file was deleted.

api-playground/json/data/okyc/[APIonly]VerifyOKYCRequest.json

-24
This file was deleted.

api-playground/products.json

-8
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,6 @@
3030
"name": "PAN verification",
3131
"path": "data/pan"
3232
},
33-
{
34-
"name": "Aadhaar KYC",
35-
"path": "data/okyc"
36-
},
3733
{
3834
"name": "BAV Reverse Penny Drop",
3935
"path": "data/bav/reverse-penny-drop"
@@ -63,10 +59,6 @@
6359
{
6460
"name": "Insights",
6561
"path": "data/insights"
66-
},
67-
{
68-
"name": "Auto OKYC",
69-
"path": "data/auto-okyc"
7062
}
7163
]
7264
}

0 commit comments

Comments
 (0)