[INJICERT-499] Added postgres plugin config docs #83
Conversation
Signed-off-by: Piyush7034 <[email protected]>
| ```mosip.mock.ida.kyc.psut.field=individualId``` | ||
| where individualId will be the identifier to locate the identity in the expected identity registry. | ||
|
|
||
| 1. Create the tables with all the fields that should be returned by the Postgres Data Provider Plugin within the certify postgres database. |
There was a problem hiding this comment.
This step is not mandatory, we can point to existing tables also, but both certify and these table should be inside the same DB and schema
There was a problem hiding this comment.
Removed this as a point and added a note in pre-requisites
| ``` | ||
|
|
||
| 2. The schema context containing all the required fields should be hosted in a public url. | ||
| - Refer this link for an existing context: [Registration Receipt Schema](https://piyush7034.github.io/my-files/registration_receipt.json) |
There was a problem hiding this comment.
This URL is giving a 404, please host in the gh-pages branch of inji-config for all the file hosting needs.
https://mosip.github.io/inji-config/logos/StayProtectedInsurance.png
https://github.com/mosip/inji-config/blob/gh-pages/logos/StayProtectedInsurance.png
this change to be done for DID and context files also, lets create a folder with env as dev1 in the root and create the DID folder for add the did.json and keep the context directly under the dev1 folder.
There was a problem hiding this comment.
File URL referred was wrong, have fixed the filename. DIDs and context schema urls will be replaced with respective public URLs once it is hosted on gh-pages branch of inji-config repo in the above specified format.
| } | ||
| } | ||
| ``` | ||
| - The primary_key should be a identifier that is existing in the current mock_identity_system records. |
There was a problem hiding this comment.
lets not stress too much on the mock_identity_system, since it is only one reference impl and the actual places this plugin to be used might not sue the mock identity system
There was a problem hiding this comment.
Removed reference of mock-identity-system as it may not be a dependency every time.
| } | ||
| } | ||
| ``` | ||
| - For referring the table creation and template insertion, see the sql scripts under certify_init.sql file: [certify-init](https://github.com/mosip/inji-certify/blob/develop/docker-compose/docker-compose-injistack/certify_init.sql) |
There was a problem hiding this comment.
docker compose sql file is subjected to change later, can we not point to the db_script folder scripts ?
There was a problem hiding this comment.
Referred the above URL to point to the db_scripts/mosip_certify/ddl folder
| - Add the fields from the respective table in the well-known config. | ||
|
|
||
| 5. mosip-config changes: | ||
| - Refer to the [authentication-config](https://github.com/mosip/mosip-config/pull/7653) properties file in mosip-config repo(esignet-mock in this case). |
There was a problem hiding this comment.
If someone is uses a different authorization server other than eSignet, then these changes are not required. Lets change the point to tell what need to be done in the authorization server high level and call out what has to be done if the authorization server is eSignet.
There was a problem hiding this comment.
Removed direct reference of esignet and added general comment to add the respective configurations corresponding to the scope-query-mapping config defined for postgres-plugin
| Eg: If "1234" is present in mock_identity table, then same identifier should be used for inserting records in the certify data tables | ||
| - When the authentication is done using this particular identifier then the record from certify tables can be fetched by the postgres plugin and returned as a JSON Object. | ||
|
|
||
| 3. Insert the templates in the DB with credential subject containing all the fields which must be the part of issued credential. |
There was a problem hiding this comment.
This point fits in the certify docs, can we add there and have a link here pointing to that ?
There was a problem hiding this comment.
Added a reference for the template_table scripts defined in db_scripts/mosip_certify/ddl folder of inji_certify.
| ``` | ||
| - For referring the table creation and template insertion, see the sql scripts under certify_init.sql file: [certify-init](https://github.com/mosip/inji-certify/blob/develop/docker-compose/docker-compose-injistack/certify_init.sql) | ||
|
|
||
| 4. inji-config changes: |
There was a problem hiding this comment.
this topic is the most important topic in this read me file to call out the config specific to this plugin and how to configure each of them
Signed-off-by: Piyush7034 <[email protected]>
No description provided.