Merge pull request #166 from shreelakshmijoshi/updating-api-doc-link

Refactor: IUDX to DX URL

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
-* Please refer to the the code of conduct : [link](https://github.com/datakaveri/iudx-acl-apd/blob/main/CODE_OF_CONDUCT.md)
-<br>
+* Please refer to the code of conduct : [link](https://github.com/datakaveri/dx-acl-apd/blob/main/CODE_OF_CONDUCT.md)
+
 * **Please check if the PR fulfills these requirements** :clipboard:
-- [ ] The commit message follows our guidelines : [link](https://github.com/datakaveri/iudx-acl-apd/blob/main/CONTRIBUTING.md)
+- [ ] The commit message follows our guidelines : [link](https://github.com/datakaveri/dx-acl-apd/blob/main/CONTRIBUTING.md)
 - [ ] Tests for the changes have been added (for bug fixes/features)
 - [ ] Docs have been added/updated (for bug fixes/features)
 - [ ] A new branch is created for the change(s) and the changes are not committed on the main or master branch
@@ -13,9 +13,9 @@
 
 * **Fixes** :wrench: # (issue)
 
-* **Checklist with respect to the current PR** :page_with_curl:
+* **Checklist for the current PR** :page_with_curl:
 - [ ] I have made corresponding changes to the documentation
-- [ ] I have added the respective changes in the [example-config](../example-config/config.json), if the changes are made in [config](../secrets/all-verticles-configs/config.json)
+- [ ] I have added the respective changes in the [example-config](../example-config/config.json) if the changes are made in [config](../secrets/all-verticles-configs/config.json)
 - [ ] For the changes made in example-config, backend components (elasticsearch, flyway files for postgres, immudb schema, rabbitmq) I have notified DX DevOps team by mentioning @datakaveri/devops as a PR comment to help facilitate the further necessary changes
 - [ ] I have mentioned the DX Catalogue items required in [resources-used](../src/test/resources/DX-Catalogue-Items/RESOURCES_USED.md)
 - [ ] I have commented on my code, particularly in hard-to-understand areas

README.md

@@ -56,16 +56,16 @@ How to get access token
 
 # Reference
 ## API Docs
-API docs are available [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/datakaveri/iudx-acl-apd/main/docs/openapi.yaml)
+API docs are available [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/datakaveri/dx-acl-apd/main/docs/openapi.yaml)
 
 ## FAQ
 FAQs are available [here](./docs/FAQ.md)
 
 ## Contributing
-Please find the information about contributing [here](https://github.com/datakaveri/iudx-acl-apd/blob/main/CONTRIBUTING.md)
+Please find the information about contributing [here](https://github.com/datakaveri/dx-acl-apd/blob/main/CONTRIBUTING.md)
 
 ## License
 [View License](./LICENSE)
 
 ## Code of Conduct
-Please find the code of conduct [here](https://github.com/datakaveri/iudx-acl-apd/blob/main/CODE_OF_CONDUCT.md)
+Please find the code of conduct [here](https://github.com/datakaveri/dx-acl-apd/blob/main/CODE_OF_CONDUCT.md)

docs/Configurations.md

@@ -4,8 +4,8 @@
 
 # Modules
 This document contains the information of the configurations to setup various services and dependencies in order to bring up the DX ACL APD Server. 
-Please find the example configuration file [here](https://github.com/datakaveri/iudx-acl-apd/blob/main/example-config/config.json). While running the server, config.json file could
-be added [secrets](https://github.com/datakaveri/iudx-acl-apd/tree/main/secrets/all-verticles-configs).
+Please find the example configuration file [here](https://github.com/datakaveri/dx-acl-apd/blob/main/example-config/config.json). While running the server, config.json file could
+be added [secrets](https://github.com/datakaveri/dx-acl-apd/tree/main/secrets/all-verticles-configs).
 
 
 ## Api Server Verticle

docs/FAQ.md

@@ -5,7 +5,7 @@
 # Frequently Asked Questions (FAQs)
 
 1. How do I request for a new feature to be added or change in an existing feature?
-- Please create an issue [here](https://github.com/datakaveri/iudx-acl-apd/issues)
+- Please create an issue [here](https://github.com/datakaveri/dx-acl-apd/issues)
 2. What do we do when there is any error during flyway migration?
 - We could run this command `mvn flyway:repair` and do the flyway migration again
 -If the error persists, it needs to be resolved manually and a backup of the database could be taken from postgres if the table needs to be changed
@@ -17,9 +17,9 @@
 - Yes, the constraints given to access the resource is defined by DX Resource server and provider could follow the same json structure to add different type of user specific constraints
 
 5. Are there any access restrictions for delegates of the provider or consumer?
-- No, delegates can access all the specific provider or consumer related APIs. Please refer [users and roles](https://github.com/datakaveri/iudx-acl-apd/blob/main/README.md)
+- No, delegates can access all the specific provider or consumer related APIs. Please refer [users and roles](https://github.com/datakaveri/dx-acl-apd/blob/main/README.md)
 
 6. “Given id is invalid - it is group level resource” - Unable to create policies for resource groups
-- From Release [version 1.0.1](https://github.com/datakaveri/iudx-acl-apd/releases/tag/v1.0.1), the policies for new resource groups are restricted to be created
+- From Release [version 1.0.1](https://github.com/datakaveri/dx-acl-apd/releases/tag/v1.0.1), the policies for new resource groups are restricted to be created
 Policies could be created for a resource item
 

docs/SETUP-and-Installation.md

@@ -112,7 +112,7 @@ Body for the API request
 ### Database Migration using Flyway
 - Database flyway migrations help in updating the schema, permissions, grants, triggers etc., with the latest version
 - Each flyway schema file is versioned with the format `V<majorVersion>_<minorVersion>__<description>.sql`, ex : `V1_1__init-tables.sql`
-- Schemas for PostgreSQL tables are present here - [Flyway schema](https://github.com/datakaveri/iudx-acl-apd/tree/main/src/main/resources/db/migration)
+- Schemas for PostgreSQL tables are present here - [Flyway schema](https://github.com/datakaveri/dx-acl-apd/tree/main/src/main/resources/db/migration)
 - Values like DB URL, database user credentials, user and schema name should be populated in flyway.conf
 - The following commands shall be executed
     - ``` mvn flyway:info -Dflyway.configFiles=flyway.conf``` To get the flyway schema history table
@@ -191,7 +191,7 @@ $ java ACL_APD_JAVA_OPTS -jar target/iudx.iudx.apd.acl.server-cluster-0.0.1-SNAP
 ## Logging and Monitoring
 ### Log4j 2
 - For asynchronous logging, logging messages to the console in a specific format, Apache's log4j 2 is used
-- For log formatting, adding appenders, adding custom logs, setting log levels, log4j2.xml could be updated : [link](https://github.com/datakaveri/iudx-acl-apd/blob/main/src/main/resources/log4j2.xml)
+- For log formatting, adding appenders, adding custom logs, setting log levels, log4j2.xml could be updated : [link](https://github.com/datakaveri/dx-acl-apd/blob/main/src/main/resources/log4j2.xml)
 - Please find the reference to log4j 2 : [here](https://logging.apache.org/log4j/2.x/manual/index.html)
 
 ### Micrometer
@@ -215,12 +215,12 @@ $ java ACL_APD_JAVA_OPTS -jar target/iudx.iudx.apd.acl.server-cluster-0.0.1-SNAP
 
 ### Integration Testing
 
-Integration tests are through Postman/Newman whose script can be found from [here](https://github.com/datakaveri/iudx-acl-apd/tree/main/src/test/resources).
+Integration tests are through Postman/Newman whose script can be found from [here](https://github.com/datakaveri/dx-acl-apd/tree/main/src/test/resources).
 1. Install prerequisites
 - [postman](https://www.postman.com/) + [newman](https://www.npmjs.com/package/newman)
 - [newman reporter-htmlextra](https://www.npmjs.com/package/newman-reporter-htmlextra)
-2. Example Postman environment can be found [here](https://github.com/datakaveri/iudx-acl-apd/blob/main/src/test/resources/DX-ACL-APD-APIs.postman_environment.json)
-- Please find the README to setup postman environment file [here](https://github.com/datakaveri/iudx-acl-apd/blob/main/src/test/resources/README.md)
+2. Example Postman environment can be found [here](https://github.com/datakaveri/dx-acl-apd/blob/main/src/test/resources/DX-ACL-APD-APIs.postman_environment.json)
+- Please find the README to setup postman environment file [here](https://github.com/datakaveri/dx-acl-apd/blob/main/src/test/resources/README.md)
 3. Run the server through either docker, maven or redeployer
 4. Run the integration tests and generate the newman report
    `newman run <postman-collection-path> -e <postman-environment> --insecure -r htmlextra --reporter-htmlextra-export .`

src/main/resources/DX-ACL-APD.postman_collection.json

@@ -1,8 +1,8 @@
 {
 	"info": {
 		"_postman_id": "bb5d58fd-9df8-46e1-bf19-e16ce66adc7f",
-		"name": "IUDX-ACL-APD",
-		"description": "**IUDX-ACL-APD** **Collection**:  \nThe \"iudx-acl-apd\" collection is a comprehensive set of APIs that encompass three essential aspects of access management within a system:\n\n1. **Token Management (Token)**:\n    - This component of the collection provides the means to acquire an Identity Access Token, which is a fundamental requirement for executing various functionalities within the system, including Policy and Access Request APIs.\n2. **Policy Management (Policy)**:\n    - The \"iudx-acl-apd\" collection includes APIs that streamline the creation, deletion, and retrieval of user-generated policies. These policies define access control rules and permissions, ensuring a structured approach to access management.\n3. **Access Request Management (Access Request)**:\n    - Within this collection, users can initiate policy requests, obtain lists of generated access requests, delete specific requests, and manage requests by approving or rejecting them.",
+		"name": "DX-ACL-APD",
+		"description": "**DX-ACL-APD** **Collection**:  \nThe \"DX-ACL-APD\" collection is a comprehensive set of APIs that encompass three essential aspects of access management within a system:\n\n1. **Token Management (Token)**:\n    - This component of the collection provides the means to acquire an Identity Access Token, which is a fundamental requirement for executing various functionalities within the system, including Policy and Access Request APIs.\n2. **Policy Management (Policy)**:\n    - The \"DX-ACL-APD\" collection includes APIs that streamline the creation, deletion, and retrieval of user-generated policies. These policies define access control rules and permissions, ensuring a structured approach to access management.\n3. **Access Request Management (Access Request)**:\n    - Within this collection, users can initiate policy requests, obtain lists of generated access requests, delete specific requests, and manage requests by approving or rejecting them.",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
 		"_exporter_id": "23856712"
 	},

src/main/resources/collection_readme.md

@@ -1,2 +1,2 @@
 # DX ACL-APD
-You can locate the Postman collection and environment for DX-ACL-APD [here](https://github.com/datakaveri/iudx-acl-apd/blob/4cb8560f6fa792a394d74f54da3f6c6572fe8f7b/src/main/resources). To gain a deeper understanding of the various APIs, please consult the collection documentation.
+You can locate the Postman collection and environment for DX-ACL-APD [here](https://github.com/datakaveri/dx-acl-apd/blob/4cb8560f6fa792a394d74f54da3f6c6572fe8f7b/src/main/resources). To gain a deeper understanding of the various APIs, please consult the collection documentation.