datakaveri / iudx-data-marketplace-apd

The data marketplace is IUDX's platform that enables data Providers to host their datasets as a product. Likewise, data consumers can buy the products listed by various providers
Apache License 2.0
0 stars 1 forks source link

DMP Documentation #103

Open shreelakshmijoshi opened 1 month ago

shreelakshmijoshi commented 1 month ago

Documentation for DMP-APD

Link to ACL-APD design document for reference: https://docs.google.com/document/d/1j289zdt2n5i81vvwJJl-lJB-D4Ld8ihQajjN3qZuGM8/edit

Key Name Value Datatype Value Example Description
isWorkerVerticle boolean false To check if worker verticle needs to be deployed for blocking operations
verticleInstances integer 1 Number of instances required for verticles
httpPort integer 8080 Port for running the instance DX ACL-APD Server
    - Other Configurations
        * include common configs and other configurations
Key Name Value Datatype Value Example Description
version Float 1.0 config version
zookeepers Array zookeeper zookeeper configuration to deploy clustered vert.x instance
clusterId String iudx-acl-apd-cluster cluster id to deploy clustered vert.x instance
commonConfig.dxApiBasePath String /dx/apd/acl/v1 API base path for DX ACL-APD. Reference : link
commonConfig.dxCatalogueBasePath String /iudx/cat/v1 API base path for DX Catalogue server. Reference : link
commonConfig.dxAuthBasePath String /auth/v1 API base path for DX AAA server. Reference : link
commonConfig.catServerHost String api.cat-test.iudx.io Host name of DX Catalogue server for fetching the information of resources, resource groups
commonConfig.catServerPort integer 443 Port number to access HTTPS APIs of Catalogue Server
commonConfig.authHost String authvertx.iudx.io Host name of DX AAA Server
* it would help us to see if there any unused configurations that could be removed from config.json
Key item ID Purpose (unit testing, integration testing, other) Details (the flow in which it is being used)
shreelakshmijoshi commented 2 weeks ago

Design Document : link