Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
1bf1658
Merge remote-tracking branch 'G2P-Connect/draft' into draft
vvujjini Sep 23, 2023
e8d1325
Merge branch 'draft' of https://github.com/spdci/standards into draft
vvujjini Sep 23, 2023
4026660
remove references to disburse, mapper files.
vvujjini Sep 23, 2023
e70e751
dci logos
vvujjini Sep 23, 2023
afe6238
Updated git book URL
Oct 3, 2023
5cbb0ee
Updated link of CRVS docs
Oct 4, 2023
1b3d725
Updated links
Oct 4, 2023
dae563b
Create initial draft for jwks endpoint
Zangetsu101 Oct 6, 2023
ed11c12
Cleanup the docs
Zangetsu101 Oct 9, 2023
616823c
Remove the jwks release files
Zangetsu101 Oct 16, 2023
a19f03e
feat: well-known locations endpoint
naftis Oct 17, 2023
dcff967
use schema.org and json-ld more strictly
naftis Oct 17, 2023
05f7e52
Add the build instruction for jwks
Zangetsu101 Oct 18, 2023
bfcf8b7
allow adding array of identifiers
naftis Oct 18, 2023
a93700a
Search APIs
Oct 31, 2023
2bd02ed
Merge pull request #11 from spdci/integrated-beneficiary-registry-api…
tntra-dhananjay Oct 31, 2023
2da5d49
Merge branch 'draft' of github.com:spdci/standards into locations-end…
naftis Oct 31, 2023
39099bd
Merge remote-tracking branch 'upstream/draft' into jwks
Zangetsu101 Nov 1, 2023
5209041
Merge pull request #9 from Zangetsu101/jwks
tntra-dhananjay Nov 8, 2023
e004704
Merge branch 'draft' into locations-endpoint
tntra-dhananjay Nov 9, 2023
dabe9e7
Merge pull request #10 from naftis/locations-endpoint
tntra-dhananjay Nov 9, 2023
74a81a2
JSON LD changes
Nov 14, 2023
6bb8445
Update LatLong.yaml
tntra-dhananjay Nov 14, 2023
63284e6
Refactored IBR Apis
Nov 22, 2023
3725275
Updated URLs
Nov 22, 2023
7d6b70c
Enum changes
Nov 22, 2023
a519750
Snake case changes
Nov 23, 2023
67be55c
Domain name changes & refactoring as per review comments
Nov 23, 2023
bcf1ac2
Refactoring
Nov 23, 2023
36d6ab7
Fixing syntax issues
vvujjini Nov 23, 2023
32b25d7
syntax issue
vvujjini Nov 23, 2023
7272afc
Draft 1
Dec 5, 2023
70d5a5f
Added build command for social
Dec 5, 2023
4b61908
Commited registry changes
Dec 5, 2023
51abebe
Yaml changes
Dec 6, 2023
7f6569b
JSON-LD ref
Dec 6, 2023
69c2580
Refactored APIs
Dec 7, 2023
da295a8
Merge pull request #13 from spdci/feature/social-registry-changes
tntra-dhananjay Dec 7, 2023
27273a8
Title changes for sicual registry
Dec 7, 2023
ed4e0da
Title changes for sicual registry
Dec 7, 2023
d319a66
refactored yaml file
tntra-priyanka Dec 7, 2023
29ae89d
conflict resolved
tntra-priyanka Dec 12, 2023
074af64
Merge pull request #14 from spdci/feature/refactoring-yaml
tntra-dhananjay Dec 12, 2023
138593a
IBR Files
Dec 13, 2023
229dde5
Added description for IBR and social
Dec 13, 2023
e5f104d
Changed description of IBR and social registry
Dec 14, 2023
f92b55d
Changed description of IBR and social registry
Dec 14, 2023
0f59d19
Updated links of json ld
Dec 15, 2023
247af20
Updated references
Dec 15, 2023
7388149
Added example req-response
Jan 2, 2024
e29acb5
Add samples
Jan 4, 2024
c430452
Update ibr.html
tntra-dhananjay Jan 4, 2024
16a68cd
Social Apis Example
Jan 16, 2024
23712df
added social Apis response
tntra-priyanka Jan 16, 2024
5e3c482
added api examples in crvs
tntra-priyanka Jan 18, 2024
cb699e1
Renamed headers
Jan 30, 2024
7d12f82
Revert "syntax issue"
vvujjini Jan 30, 2024
3bdbc89
Revert "Fixing syntax issues"
vvujjini Jan 30, 2024
82aaa63
Merge branch 'draft' of https://github.com/spdci/standards into draft
vvujjini Jan 30, 2024
704d400
Example changes
Feb 2, 2024
9d3aac8
House hold example
Feb 2, 2024
4c61dc0
Updated headers
Feb 2, 2024
1fba324
DC
Feb 12, 2024
f802e9d
Revert "DC"
Feb 13, 2024
d476f50
IBR recepit endpoint
Feb 14, 2024
9b8cb67
Update build_instructions.md
tntra-dhananjay Apr 19, 2024
236c2bf
api
aishamerhebi Jul 15, 2024
3410011
api updates
aishamerhebi Jul 16, 2024
ba44b3d
updated notes
aishamerhebi Jul 17, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ proguard/
captures/

# IntelliJ
.idea
*.iml
.idea/workspace.xml
.idea/codeStyles/Project.xml
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
# API documentation

The APIs are accessible through
1. DCI: [standards](https://spdci.github.io/standards/release/index.html)
2. G2P Community: [specifications](https://g2p-connect.github.io/specs/release/index.html)
1. DCI: [standards](https://standards.spdci.org/standards/release/index.html)

## Discussion forum

To initiate any discussion please visit [discussion page](https://github.com/orgs/spdci/discussions).

**IMPORTANT NOTES:**
1. Final release for consuming these APIs (yaml, html) are available in specs/release folder.
2. Contribute to G2P Connect specification or DCI standards APIs through pull requests in respective specs/src folder.
2. Contribute to DCI standards APIs through pull requests in respective specs/src folder.
3. specs/release folder files are auto generated and it's NOT recommended to edit these directly.
4. specs/release filder API files are for final consumption by solution providers to make their services compatible with G2P Connect / DCI standards.
4. specs/release filder API files are for final consumption by solution providers to make their services compatible with DCI standards.

### Reference Links
1. Build [Instructions](./build/build_instructions.md)
Expand Down
35 changes: 27 additions & 8 deletions build/build_apis.cmd
Original file line number Diff line number Diff line change
@@ -1,13 +1,32 @@
# This file auto generates all g2p connect yaml files.
# Assumes the command is run from the root folder i.e ./specs
# This file auto generates all yaml files.
# Assumes the command is run from the root folder i.e ./standards
# For each new category, please make sure to add a reference link in this file for easy auto generation of yamls.

# build auth APIs
swagger-cli -f 2 -t yaml bundle ./src/authz/authz_core_api_v1.0.0.yaml -o ./release/yaml/authz_core_api_v1.0.0.yaml
swagger-cli -f 2 -t yaml bundle ./src/registry/registry_core_api_v1.0.0.yaml -o ./release/yaml/registry_core_api_v1.0.0.yaml
swagger-cli -f 2 -t yaml bundle ./src/mapper/mapper_core_api_v1.0.0.yaml -o ./release/yaml/mapper_core_api_v1.0.0.yaml
swagger-cli -f 2 -t yaml bundle ./src/disburse/disburse_core_api_v1.0.0.yaml -o ./release/yaml/disburse_core_api_v1.0.0.yaml

redocly build-docs ./release/yaml/authz_core_api_v1.0.0.yaml -o ./release/html/authz_core_api_v1.0.0.html

# build APIs
swagger-cli -f 2 -t yaml bundle ./src/registry/registry_core_api_v1.0.0.yaml -o ./release/yaml/registry_core_api_v1.0.0.yaml
redocly build-docs ./release/yaml/registry_core_api_v1.0.0.yaml -o ./release/html/registry_core_api_v1.0.0.html
redocly build-docs ./release/yaml/mapper_core_api_v1.0.0.yaml -o ./release/html/mapper_core_api_v1.0.0.html
redocly build-docs ./release/yaml/disburse_core_api_v1.0.0.yaml -o ./release/html/disburse_core_api_v1.0.0.html

swagger-cli -f 2 -t yaml bundle ./src/registry/ibr_api_v1.0.0.yaml -o ./release/yaml/ibr_api_v1.0.0.yaml
redocly build-docs ./release/yaml/ibr_api_v1.0.0.yaml -o ./release/html/ibr_api_v1.0.0.html

swagger-cli -f 2 -t yaml bundle ./src/registry/social_api_v1.0.0.yaml -o ./release/yaml/social_api_v1.0.0.yaml
redocly build-docs ./release/yaml/social_api_v1.0.0.yaml -o ./release/html/social_api_v1.0.0.html


# build locations APIs
swagger-cli -f 2 -t yaml bundle ./src/locations/locations_core_api_v1.0.0.yaml -o ./release/yaml/locations_core_api_v1.0.0.yaml
redocly build-docs ./release/yaml/locations_core_api_v1.0.0.yaml -o ./release/html/locations_core_api_v1.0.0.html

# build jwks APIs
swagger-cli -f 2 -t yaml bundle ./src/jwks/jwks_core_api_v1.0.0.yaml -o ./release/yaml/jwks_core_api_v1.0.0.yaml
redocly build-docs ./release/yaml/jwks_core_api_v1.0.0.yaml -o ./release/html/jwks_core_api_v1.0.0.html


# swagger-cli -f 2 -t yaml bundle ./src/mapper/mapper_core_api_v1.0.0.yaml -o ./release/yaml/mapper_core_api_v1.0.0.yaml
# swagger-cli -f 2 -t yaml bundle ./src/disburse/disburse_core_api_v1.0.0.yaml -o ./release/yaml/disburse_core_api_v1.0.0.yaml
# redocly build-docs ./release/yaml/mapper_core_api_v1.0.0.yaml -o ./release/html/mapper_core_api_v1.0.0.html
# redocly build-docs ./release/yaml/disburse_core_api_v1.0.0.yaml -o ./release/html/disburse_core_api_v1.0.0.html
8 changes: 8 additions & 0 deletions build/build_instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,11 @@ bundled successfully in: ./release/html/registry_core_api_v1.0.0.html
```

6. Commit the changes and push the updated code to git repo. Create pull requests for teams to collaborate and merge to main branch!

## How this published on website

The github actions used to publish this as website, you can map branch / folder which to be published as webpages root path.

Below link will help to understand how it works

https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site
6 changes: 6 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading