Commit 51f40a76 authored by Jorge Moratinos's avatar Jorge Moratinos
Browse files

added some notes

parent d03030e8
Loading
Loading
Loading
Loading
+59 −23
Original line number Diff line number Diff line
@@ -4,41 +4,77 @@

#### 3GPP CAPIF release 18

- Added new endpoints included in new release 18.
  - New logic for PATCH endpoints.
- New logic to support Vendor Extensibility
  - 9 new tests to check this logic.
- New logic to support API Status feature
- Supported Features now are mandatory for all POST Requests as is described on TS 29.222.
    - Possible Breaking change, all POST request now must include supported features attribute, default can me set to "0" to keep all features inactive.
    - Possible Breaking change on Events API, if you need eventDetails information on notification you must activate Enhanced Event Report on supported features.
- New 8 tests on Events API to check supported features support.

- New endpoints included in new release 18 with new logic.
- New logic to support Vendor Extensibility on Publish Service.
- New logic to support API Status feature on Publish and Events Services.
- Supported Features now are mandatory for all POST and PUT Requests as is described on TS 29.222.
    - **Possible Breaking change**, all POST request now must include supported features attribute, default can me set to "0" to keep all features inactive.
    - **Possible Breaking change** on Events API, if you need eventDetails information on notification you must activate **Enhanced Event Report** feature by setting properly the supported features flag.

### **Technical Debt Solved**

#### **Issues**
#### **Api Status feature**

- REDIS scheduled on start to allow receive notification since service is deployed.
- Problem removing service APIs published is provider register more than one APF.
- Superadmin problem deleting service API published through helper service if provider is not present.
- Events API:
    - Event internal notifications between services improved to accomplish specification.
    - On event subscription **SupportedFeatures** is readed and stored in db to accomplish specification.
    - Also **SupportedFeatures** is checked before send event notification, in order to accomplish specification, sending **eventDetails** and related information according to ***enhanced_event_report*** and ***apiStatusMonitoring*** supported features activated.

#### Scripts upgraded
#### **Issues**

- New local scripts
- New remote scripts
- Solved issue to gert ready REDIS on deployment: REDIS scheduled on start to allow receive notification since service is deployed.
- Solved problem removing service APIs published is provider register more than one APF.
- Solved Superadmin problem deleting service API published through helper service if provider is not present.
- Increased the overall stability, fixing some corner cases.
- Location headers now are filled in same way at all services that needs it.
- Security issues solved.
- Base docker images present on ETSI registry.
- Robot image uploaded to ETSI Registry.

#### Local Scripts

- All scripts were reviewed and improved.
- New scripts to manage users on local deployment added:
  - create_users.sh: helps developer to create new users in local deployment.
  - remove_users.sh: helps developer to remove users from db in local deployment.

#### Remote Scripts

New scripts developed to help on remote deployment, configuration and testing. All this script are stored under helm/scripts in capif repository.

***variables.sh*** contains all configuration that will be used on remote operation. This file must be filled carefully before run remote scripts.

- Deployment Scripts:
    - ***install_vault.sh***: This script will configure and execute helm install of vault chart. This script also execute job to configure vault.
    - ***install_monitoring.sh***: This script will configure and execute helm install of monitoring chart.
    - ***install_capif.sh***: This script will configure and execute helm install of capif component chart.
    - ***uninstall_vault.sh***: This script uninstall vault component from remote environment.
    - ***uninstall_monitoring.sh***: This script uninstall monitoring components from remote environment.
    - ***uninstall_capif.sh***: This script uninstall capif components from remote environment.

- Manage remote users:
    - ***create_remote_users.sh***
    - ***remove_remote_users.sh***
    - ***remove_remote_users_by_prefix.sh***
- Execute robot tests over remote deployment.
    - ***run_remote_capif_tests.sh***

- Other helpful scripts:
    - ***get_ingress.sh***: returns all ingress of a k8s namespace with ip to put on /etc/hosts to have a fixed DNS local resolution.
    - ***set_ingress.sh***: Is the same than get_ingress.sh but it also add those fixed dns local resolution to /etc/hosts
    - ***populate_create_remote_dummy_users.sh***: This script is created mainly for testing remote deployment with dummy information, onboarding invokers, providers, publishing apis and creating security context for all of them.
    - ***populate_remove_remote_dummy_users.sh***: This scripts remove all dummy information loaded.

### **Documentation**

#### New test included on documentation

- New 9 test on Vendor Extensibility test plan.
- New 8 tests on Events API test plan.
- Test plan updated with default supported features for all request set to "0" (all inactive by default).
- New Vendor Extensibility test suite with 9 tests. [Api Events Service](./testing/testplan/vendor_extensibility/README.md)
- New [API Status feature](./testing/testplan/api_status/README.md) test suite.
- Improved [Events test suite](./testing/testplan/api_events_service/README.md) with 8 new tests.
- Test plan updated with default supported features for all request set to "0" (all inactive by default) [See common operations](./testing/testplan/common_operations/README.md).



--->>>>  must be included - New tests to check PATCH request
---

## **Release 1.0.0**