wso2 / docs-open-banking

Apache License 2.0
39 stars 25 forks source link

[MigrationTool] [CDS] Give instructions to update the API endpoints #608

Closed Dinushi closed 2 years ago

Dinushi commented 2 years ago

Affected OB version:

Affected OB specifications:

CDS

Existing pages to be updated:

  1. https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/upgrading-wso2-api-manager-400/

  2. https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/modifications-after-migration/

  3. https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/open-banking-data-migration/

    Description (Optional):

  4. Similar to https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/upgrading-wso2-api-manager-400/#replace-custom-mediation-policies, a new section should be added with instruction to update the API endpoints of the migrated APIs following the API Deployment section for each API in the CDS toolkit documentation.

  5. The config in https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/modifications-after-migration/#open-banking-internal-scopes section should be updated as follows and the instruction should be given to verify whether the <IS_HOME>/repository/conf/deployment.toml file contains the config as follows.

    [oauth]
    allowed_scopes = ["OB_.*", "profile"]
  6. Since, Two-Factor authentication is supported by default in CDS toolkit, the following section can be removed. https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/modifications-after-migration/#two-factor-authentication

  7. Add an info section under point 5 of https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/open-banking-data-migration/ and state the following.

    If the consent amendment history feature is enabled in your OB 200 solution, the migration tool should be enabled to migrate the Consent History data. For that set the consent_history_enabled property to true under the ConsentMigrator of AU spec as follows.

      -
        name: "ConsentMigrator"
        spec: "AU"
        order: 1
        parameters:
          schema: "ob"
          token_expiry_time: "84600"
          expired_custom_status: "Expired"
          consent_history_enabled: "true"
  8. Give additional info under point 1 in https://cds.ob.docs.wso2.com/en/latest/install-and-setup/upgrading-the-solution/open-banking-data-migration/ as follows. If the consent amendment history feature is enabled in your OB 200 solution, run the relevant SQL script in the <IS_HOME>/dbscripts/open-banking/consent-history directory against the openbank_openbankingdb database.

    Instructions:

    Release date:

    References:

    Labels:

isharailanga commented 2 years ago

Fixed point 2 in f346dfe and points 4 &5 in 04a40de

isharailanga commented 2 years ago

Fixed point 3 in fc9f512

isharailanga commented 2 years ago

Fixed point 1 in 1f8df95

isharailanga commented 2 years ago

This is fixed via https://github.com/wso2/docs-ob-toolkit-cds/pull/49.