From 39022025a213aa64b14884d5923f2d4b068190c8 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Fri, 8 Nov 2024 11:57:33 +0530 Subject: [PATCH 1/7] MOSIP-37357 Corrected readme Signed-off-by: kameshsr --- authentication/README.md | 2 +- .../README.md | 2 +- pre-registration-booking-service/README.md | 44 +++++++++++++++++++ .../README.md | 43 ++++++++++++++++++ .../README.md | 43 ++++++++++++++++++ 5 files changed, 132 insertions(+), 2 deletions(-) diff --git a/authentication/README.md b/authentication/README.md index 98c1b0ef7de..53862f7c204 100644 --- a/authentication/README.md +++ b/authentication/README.md @@ -1 +1 @@ -This code is moved to id-authentication repo and placed under the authentication-internal-service. \ No newline at end of file +This code is moved to id-authentication repo and placed under the authentication-common. \ No newline at end of file diff --git a/authentication/authentication-childauthfilter-impl/README.md b/authentication/authentication-childauthfilter-impl/README.md index 98c1b0ef7de..53862f7c204 100644 --- a/authentication/authentication-childauthfilter-impl/README.md +++ b/authentication/authentication-childauthfilter-impl/README.md @@ -1 +1 @@ -This code is moved to id-authentication repo and placed under the authentication-internal-service. \ No newline at end of file +This code is moved to id-authentication repo and placed under the authentication-common. \ No newline at end of file diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index a681f2c39fb..43c89a4efe1 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -6,3 +6,47 @@ This service details used by Pre-Registration portal to book an appointment by p ## Default context, path, port Refer to [bootstrap properties](src/main/resources/bootstrap.properties) +## Build & run (for developers) +The project requires JDK 1.21. +and mvn version - 3.9.6 + +1. Build and install: + ``` + $ cd pre-registration-booking-service + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +### Add auth-adapter in a class-path to run a master-data service + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration files +Pre-registration Service uses the following configuration files: +``` +application-default.properties +pre-registration-default.properties +``` +Need to run the config-server along with the files mentioned above in order to run the master-data service. + +## Configuration +[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and +[Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/develop/pre-registration-default.properties) defined here. + +Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. \ No newline at end of file diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index 0012f646f93..a4514a57dee 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -13,3 +13,46 @@ server.servlet.path=/registrationprocessor/v1/eis ## Operations done by the Service 1. It returns boolean value true for every non null requests + +## Build & run (for developers) +The project requires JDK 1.21. +and mvn version - 3.9.6 + +1. Build and install: + ``` + $ cd registration-processor\registration-processor-external-integration-service + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +### Add auth-adapter in a class-path to run a master-data service + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration files +Pre-registration Service uses the following configuration files: +``` +application-default.properties +pre-registration-default.properties +``` +Need to run the config-server along with the files mentioned above in order to run the master-data service. + +## Configuration +[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and +[Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index 5aa9e3cc0be..c9c7cc2b2f9 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -30,3 +30,46 @@ mosip.regproc.external.server.servlet.path=/registrationprocessor/v1/external ``` ## Operations in External stage External validation by sending requests to external integration system + +## Build & run (for developers) +The project requires JDK 1.21. +and mvn version - 3.9.6 + +1. Build and install: + ``` + $ cd registration-processor\registration-processor-external-stage + $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true + ``` + +### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration + ``` + hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect + ``` +This is for better compatibility with future PostgreSQL versions. + +### Configure ANT Path Matcher for Spring Boot 3.x compatibility. + ``` + spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER + ``` +This is to maintain compatibility with existing ANT-style path patterns. + +### Add auth-adapter in a class-path to run a master-data service + ``` + + io.mosip.kernel + kernel-auth-adapter + ${kernel.auth.adapter.version} + + ``` + +## Configuration files +Pre-registration Service uses the following configuration files: +``` +application-default.properties +pre-registration-default.properties +``` +Need to run the config-server along with the files mentioned above in order to run the master-data service. + +## Configuration +[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and +[Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. From 1e00944b2148841711e1a6401ddf72d8a3ced2e5 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Fri, 8 Nov 2024 13:52:10 +0530 Subject: [PATCH 2/7] MOSIP-37357 Corrected java version Signed-off-by: kameshsr --- pre-registration-booking-service/README.md | 2 +- .../README.md | 2 +- .../registration-processor-external-stage/README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index 43c89a4efe1..53fba03a515 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -7,7 +7,7 @@ This service details used by Pre-Registration portal to book an appointment by p Refer to [bootstrap properties](src/main/resources/bootstrap.properties) ## Build & run (for developers) -The project requires JDK 1.21. +The project requires JDK 21.0.3 and mvn version - 3.9.6 1. Build and install: diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index a4514a57dee..3c0ed18fc07 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -15,7 +15,7 @@ server.servlet.path=/registrationprocessor/v1/eis 1. It returns boolean value true for every non null requests ## Build & run (for developers) -The project requires JDK 1.21. +The project requires JDK 21.0.3 and mvn version - 3.9.6 1. Build and install: diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index c9c7cc2b2f9..269f0ef2d55 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -32,7 +32,7 @@ mosip.regproc.external.server.servlet.path=/registrationprocessor/v1/external External validation by sending requests to external integration system ## Build & run (for developers) -The project requires JDK 1.21. +The project requires JDK 21.0.3 and mvn version - 3.9.6 1. Build and install: From b16d0aceed2aa7341c8fdf33fa209bba325e2825 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Fri, 8 Nov 2024 15:30:17 +0530 Subject: [PATCH 3/7] MOSIP-37357 Corrected readme file Signed-off-by: kameshsr --- pre-registration-booking-service/README.md | 42 +++++++++++++++++-- .../README.md | 38 ++++++++++++++++- .../README.md | 37 +++++++++++++++- 3 files changed, 111 insertions(+), 6 deletions(-) diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index 53fba03a515..90b0faefeee 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -3,8 +3,8 @@ ## Overview This service details used by Pre-Registration portal to book an appointment by providing his/her basic appointment details -## Default context, path, port -Refer to [bootstrap properties](src/main/resources/bootstrap.properties) +## Databases +Refer to [SQL scripts](https://github.com/mosip/pre-registration/tree/develop/db_scripts). ## Build & run (for developers) The project requires JDK 21.0.3 @@ -15,6 +15,11 @@ and mvn version - 3.9.6 $ cd pre-registration-booking-service $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` ### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration ``` @@ -49,4 +54,35 @@ Need to run the config-server along with the files mentioned above in order to r [Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and [Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/develop/pre-registration-default.properties) defined here. -Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. \ No newline at end of file +Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. + +## Default context, path, port +Refer to [bootstrap properties](src/main/resources/bootstrap.properties) + +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index 3c0ed18fc07..f8f9830264e 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -14,6 +14,9 @@ server.servlet.path=/registrationprocessor/v1/eis ## Operations done by the Service 1. It returns boolean value true for every non null requests +## Overview +This service details used by Registration service for external integration service. + ## Build & run (for developers) The project requires JDK 21.0.3 and mvn version - 3.9.6 @@ -23,7 +26,12 @@ and mvn version - 3.9.6 $ cd registration-processor\registration-processor-external-integration-service $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` - +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` + ### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration ``` hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect @@ -56,3 +64,31 @@ Need to run the config-server along with the files mentioned above in order to r ## Configuration [Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and [Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. + +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index 269f0ef2d55..f5bd1b8acc4 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -1,5 +1,6 @@ # registration-processor-external-stage +## Overview This stage integrates with external system for required external operations ## Design @@ -40,7 +41,11 @@ and mvn version - 3.9.6 $ cd registration-processor\registration-processor-external-stage $ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true ``` - +2. Build Docker for a service: + ``` + $ cd + $ docker build -f Dockerfile + ``` ### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration ``` hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect @@ -66,10 +71,38 @@ This is to maintain compatibility with existing ANT-style path patterns. Pre-registration Service uses the following configuration files: ``` application-default.properties -pre-registration-default.properties +registration-default.properties ``` Need to run the config-server along with the files mentioned above in order to run the master-data service. ## Configuration [Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and [Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. + +## Deployment in K8 cluster with other MOSIP services: +### Pre-requisites +* Set KUBECONFIG variable to point to existing K8 cluster kubeconfig file: + ``` + export KUBECONFIG=~/.kube/ + ``` +### Install + ``` + $ cd deploy + $ ./install.sh + ``` +### Delete + ``` + $ cd deploy + $ ./delete.sh + ``` +### Restart + ``` + $ cd deploy + $ ./restart.sh + ``` + +## APIs +API documentation is available [here](https://mosip.github.io/documentation/). + +## License +This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file From 04358bd9bddd9c0167e3a88ac1fb66f105d4fdcd Mon Sep 17 00:00:00 2001 From: kameshsr Date: Mon, 11 Nov 2024 10:31:39 +0530 Subject: [PATCH 4/7] MOSIP-37357 Corrected readme Signed-off-by: kameshsr --- pre-registration-booking-service/README.md | 28 +++---------- .../README.md | 41 ++++--------------- .../README.md | 24 +---------- 3 files changed, 14 insertions(+), 79 deletions(-) diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index 90b0faefeee..3e9ba5f7e8a 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -4,7 +4,7 @@ This service details used by Pre-Registration portal to book an appointment by providing his/her basic appointment details ## Databases -Refer to [SQL scripts](https://github.com/mosip/pre-registration/tree/develop/db_scripts). +Refer to the required released tagged version [SQL scripts](https://github.com/mosip/pre-registration/tree/master/db_scripts). ## Build & run (for developers) The project requires JDK 21.0.3 @@ -21,18 +21,6 @@ and mvn version - 3.9.6 $ docker build -f Dockerfile ``` -### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration - ``` - hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect - ``` -This is for better compatibility with future PostgreSQL versions. - -### Configure ANT Path Matcher for Spring Boot 3.x compatibility. - ``` - spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER - ``` -This is to maintain compatibility with existing ANT-style path patterns. - ### Add auth-adapter in a class-path to run a master-data service ``` @@ -44,17 +32,11 @@ This is to maintain compatibility with existing ANT-style path patterns. ## Configuration files Pre-registration Service uses the following configuration files: -``` -application-default.properties -pre-registration-default.properties -``` +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and +[Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) defined here. Need to run the config-server along with the files mentioned above in order to run the master-data service. -## Configuration -[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and -[Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/develop/pre-registration-default.properties) defined here. - -Refer [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. +Refer to the required released tagged version [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. ## Default context, path, port Refer to [bootstrap properties](src/main/resources/bootstrap.properties) @@ -82,7 +64,7 @@ Refer to [bootstrap properties](src/main/resources/bootstrap.properties) ``` ## APIs -API documentation is available [here](https://mosip.github.io/documentation/). +API documentation is available [here](https://mosip.github.io/documentation/1.2.0/pre-registration-booking-service.html). ## License This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index f8f9830264e..1865075a994 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -1,5 +1,8 @@ # registration-processor-external-integration-service +## Overview +This service details used by Registration service for external integration service. + ## Design [Design - Approach for External System Integration](https://github.com/mosip/registration/blob/master/design/registration-processor/Approach_for_external_system_integration.md) @@ -12,10 +15,7 @@ server.servlet.path=/registrationprocessor/v1/eis ``` ## Operations done by the Service -1. It returns boolean value true for every non null requests - -## Overview -This service details used by Registration service for external integration service. +1. It returns boolean value true for every non-null requests ## Build & run (for developers) The project requires JDK 21.0.3 @@ -31,39 +31,12 @@ and mvn version - 3.9.6 $ cd $ docker build -f Dockerfile ``` - -### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration - ``` - hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect - ``` -This is for better compatibility with future PostgreSQL versions. - -### Configure ANT Path Matcher for Spring Boot 3.x compatibility. - ``` - spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER - ``` -This is to maintain compatibility with existing ANT-style path patterns. - -### Add auth-adapter in a class-path to run a master-data service - ``` - - io.mosip.kernel - kernel-auth-adapter - ${kernel.auth.adapter.version} - - ``` ## Configuration files -Pre-registration Service uses the following configuration files: -``` -application-default.properties -pre-registration-default.properties -``` -Need to run the config-server along with the files mentioned above in order to run the master-data service. - -## Configuration +Registration processor external integration Service uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and [Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. +Need to run the config-server along with the files mentioned above in order to run the master-data service. ## Deployment in K8 cluster with other MOSIP services: ### Pre-requisites @@ -88,7 +61,7 @@ Need to run the config-server along with the files mentioned above in order to r ``` ## APIs -API documentation is available [here](https://mosip.github.io/documentation/). +API documentation is available [here](https://mosip.github.io/documentation/1.2.0/registration-processor-external-integration-service.html). ## License This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index f5bd1b8acc4..f6535c5b852 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -46,17 +46,6 @@ and mvn version - 3.9.6 $ cd $ docker build -f Dockerfile ``` -### Remove the version-specific suffix (PostgreSQL95Dialect) from the Hibernate dialect configuration - ``` - hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect - ``` -This is for better compatibility with future PostgreSQL versions. - -### Configure ANT Path Matcher for Spring Boot 3.x compatibility. - ``` - spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER - ``` -This is to maintain compatibility with existing ANT-style path patterns. ### Add auth-adapter in a class-path to run a master-data service ``` @@ -68,16 +57,10 @@ This is to maintain compatibility with existing ANT-style path patterns. ``` ## Configuration files -Pre-registration Service uses the following configuration files: -``` -application-default.properties -registration-default.properties -``` -Need to run the config-server along with the files mentioned above in order to run the master-data service. - -## Configuration +Registration processor external stage uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and [Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. +Need to run the config-server along with the files mentioned above in order to run the master-data service. ## Deployment in K8 cluster with other MOSIP services: ### Pre-requisites @@ -101,8 +84,5 @@ Need to run the config-server along with the files mentioned above in order to r $ ./restart.sh ``` -## APIs -API documentation is available [here](https://mosip.github.io/documentation/). - ## License This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file From b9a8640bc34ea566303e0dddbf45d96955f8273f Mon Sep 17 00:00:00 2001 From: kameshsr Date: Tue, 12 Nov 2024 13:39:01 +0530 Subject: [PATCH 5/7] MOSIP-37357 Corrected readme Signed-off-by: kameshsr --- pre-registration-booking-service/README.md | 12 +++++++++--- .../README.md | 11 ++++++----- .../registration-processor-external-stage/README.md | 9 +++++---- 3 files changed, 20 insertions(+), 12 deletions(-) diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index 3e9ba5f7e8a..bb49d5f59a1 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -28,13 +28,19 @@ and mvn version - 3.9.6 kernel-auth-adapter ${kernel.auth.adapter.version} + + io.mosip.kernel + kernel-ref-idobjectvalidator + ${kernel.ref.idobjectvalidator.version} + ``` ## Configuration files Pre-registration Service uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) defined here. -Need to run the config-server along with the files mentioned above in order to run the master-data service. + +Need to run the config-server along with the files mentioned above in order to run the pre-registration booking service. Refer to the required released tagged version [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. @@ -64,7 +70,7 @@ Refer to [bootstrap properties](src/main/resources/bootstrap.properties) ``` ## APIs -API documentation is available [here](https://mosip.github.io/documentation/1.2.0/pre-registration-booking-service.html). +API documentation is available [here](https://mosip.github.io/documentation/). ## License -This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file +This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE). \ No newline at end of file diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index 1865075a994..cd103221539 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -34,9 +34,10 @@ and mvn version - 3.9.6 ## Configuration files Registration processor external integration Service uses the following configuration files: -[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and -[Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. -Need to run the config-server along with the files mentioned above in order to run the master-data service. +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and +[Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here. + +Need to run the config-server along with the files mentioned above in order to run the registration processor external integration service. ## Deployment in K8 cluster with other MOSIP services: ### Pre-requisites @@ -61,7 +62,7 @@ Need to run the config-server along with the files mentioned above in order to r ``` ## APIs -API documentation is available [here](https://mosip.github.io/documentation/1.2.0/registration-processor-external-integration-service.html). +API documentation is available [here](https://mosip.github.io/documentation/). ## License -This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file +This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE). \ No newline at end of file diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index f6535c5b852..f544ca48e87 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -58,9 +58,10 @@ and mvn version - 3.9.6 ## Configuration files Registration processor external stage uses the following configuration files: -[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) and -[Configuration-Registration](https://github.com/mosip/mosip-config/blob/develop/registration-default.properties) defined here. -Need to run the config-server along with the files mentioned above in order to run the master-data service. +[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and +[Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here. + +Need to run the config-server along with the files mentioned above in order to run the registration processor external stage service. ## Deployment in K8 cluster with other MOSIP services: ### Pre-requisites @@ -85,4 +86,4 @@ Need to run the config-server along with the files mentioned above in order to r ``` ## License -This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE). \ No newline at end of file +This project is licensed under the terms of [Mozilla Public License 2.0](https://github.com/mosip/mosip-ref-impl/blob/master/LICENSE). \ No newline at end of file From 09bdd398f2bd7a2c542d631c45d8cb06d200bcc5 Mon Sep 17 00:00:00 2001 From: kameshsr Date: Tue, 12 Nov 2024 13:43:33 +0530 Subject: [PATCH 6/7] MOSIP-37357 Corrected readme Signed-off-by: kameshsr --- pre-registration-booking-service/README.md | 4 ++-- .../README.md | 2 ++ .../registration-processor-external-stage/README.md | 2 ++ 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index bb49d5f59a1..beb3059fcec 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -40,9 +40,9 @@ Pre-registration Service uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) defined here. -Need to run the config-server along with the files mentioned above in order to run the pre-registration booking service. +Refer to the required released tagged version -Refer to the required released tagged version [Module Configuration](https://docs.mosip.io/1.2.0/modules/module-configuration) for location of these files. +Need to run the config-server along with the files mentioned above in order to run the pre-registration booking service. ## Default context, path, port Refer to [bootstrap properties](src/main/resources/bootstrap.properties) diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index cd103221539..bd7f602a8b7 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -37,6 +37,8 @@ Registration processor external integration Service uses the following configura [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here. +Refer to the required released tagged version + Need to run the config-server along with the files mentioned above in order to run the registration processor external integration service. ## Deployment in K8 cluster with other MOSIP services: diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index f544ca48e87..854720de92a 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -61,6 +61,8 @@ Registration processor external stage uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here. +Refer to the required released tagged version + Need to run the config-server along with the files mentioned above in order to run the registration processor external stage service. ## Deployment in K8 cluster with other MOSIP services: From 8af9c30f0246db22f6256e5103f271cbd1fd7dad Mon Sep 17 00:00:00 2001 From: kameshsr Date: Tue, 12 Nov 2024 13:45:50 +0530 Subject: [PATCH 7/7] MOSIP-37357 Corrected readme Signed-off-by: kameshsr --- pre-registration-booking-service/README.md | 3 +-- .../README.md | 3 +-- .../registration-processor-external-stage/README.md | 3 +-- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/pre-registration-booking-service/README.md b/pre-registration-booking-service/README.md index beb3059fcec..c81a9694f82 100644 --- a/pre-registration-booking-service/README.md +++ b/pre-registration-booking-service/README.md @@ -39,8 +39,7 @@ and mvn version - 3.9.6 Pre-registration Service uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Pre-registration](https://github.com/mosip/mosip-config/blob/master/pre-registration-default.properties) defined here. - -Refer to the required released tagged version +Refer to the required released tagged version. Need to run the config-server along with the files mentioned above in order to run the pre-registration booking service. diff --git a/registration-processor/registration-processor-external-integration-service/README.md b/registration-processor/registration-processor-external-integration-service/README.md index bd7f602a8b7..be1c6086ee0 100644 --- a/registration-processor/registration-processor-external-integration-service/README.md +++ b/registration-processor/registration-processor-external-integration-service/README.md @@ -36,8 +36,7 @@ and mvn version - 3.9.6 Registration processor external integration Service uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here. - -Refer to the required released tagged version +Refer to the required released tagged version. Need to run the config-server along with the files mentioned above in order to run the registration processor external integration service. diff --git a/registration-processor/registration-processor-external-stage/README.md b/registration-processor/registration-processor-external-stage/README.md index 854720de92a..59686ca498e 100644 --- a/registration-processor/registration-processor-external-stage/README.md +++ b/registration-processor/registration-processor-external-stage/README.md @@ -60,8 +60,7 @@ and mvn version - 3.9.6 Registration processor external stage uses the following configuration files: [Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) and [Configuration-Registration-processor](https://github.com/mosip/mosip-config/blob/master/registration-processor-default.properties) defined here. - -Refer to the required released tagged version + Refer to the required released tagged version. Need to run the config-server along with the files mentioned above in order to run the registration processor external stage service.