implement OSPO guidelines

CONTRIBUTING.md

@@ -3,8 +3,7 @@
 We're really glad you want to help.
 
 ## Here are some important resources:
-
-  * Want to add something from yourself? [Make a PR](https://github.com/CiscoDevNet/catalystwan/pulls) - remember to follow code guidelines.
+  * Want to add something from yourself? [Make a PR](https://github.com/CiscoDevNet/catalystwan/pulls) - remember to follow [code guidelines](#code-guidelines).
     ### Contributors from CiscoDevNet organization:
     To make a PR - pull the repository, create branch for your changes, make said changes and make the pull request. Now just wait for the review and feedback from our developers.  
     ### Contributors outside CiscoDevNet organization

catalystwan/__init__.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 import logging
 import logging.config
 import multiprocessing

catalystwan/abstractions.py

@@ -1,3 +1,5 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
 from typing import Optional, Protocol, Type, TypeVar
 
 from packaging.version import Version  # type: ignore

catalystwan/api/admin_tech_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 """
 Module for handling admintech logs for a device
 """

catalystwan/api/administration.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/alarms_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/api_container.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

catalystwan/api/basic_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 """Methods covering essential API endpoints and related data classes."""
 from __future__ import annotations
 

catalystwan/api/config_device_inventory_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

catalystwan/api/config_group_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

catalystwan/api/configuration_groups/parcel.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from typing import Any, Dict, Generic, Literal, Optional, TypeVar, get_origin
 

catalystwan/api/configuration_groups/parcels/cellular_controller.py

@@ -1,3 +1,5 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from typing import Union
 

catalystwan/api/dashboard_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING

catalystwan/api/device_action_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/feature_profile_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Protocol, Type, Union, overload

catalystwan/api/logs_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/monitoring_status_api.py

@@ -1,3 +1,5 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/mtt_aaa_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/omp_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, List

catalystwan/api/packet_capture_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/parcel_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Protocol

catalystwan/api/partition_manager_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/policy_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Dict, List, Mapping, Optional, Type, overload
@@ -122,13 +124,13 @@
 from catalystwan.endpoints.configuration.policy.list.site import ConfigurationPolicySiteList, SiteListInfo
 from catalystwan.endpoints.configuration.policy.list.sla import ConfigurationPolicySLAClassList, SLAClassListInfo
 from catalystwan.endpoints.configuration.policy.list.tloc import ConfigurationPolicyTLOCList, TLOCListInfo
-from catalystwan.endpoints.configuration.policy.list.url_black_list import (
-    ConfigurationPolicyURLBlackList,
-    URLBlackListInfo,
+from catalystwan.endpoints.configuration.policy.list.url_allow_list import (
+    ConfigurationPolicyURLAllowList,
+    URLAllowListInfo,
 )
-from catalystwan.endpoints.configuration.policy.list.url_white_list import (
-    ConfigurationPolicyURLWhiteList,
-    URLWhiteListInfo,
+from catalystwan.endpoints.configuration.policy.list.url_block_list import (
+    ConfigurationPolicyURLBlockList,
+    URLBlockListInfo,
 )
 from catalystwan.endpoints.configuration.policy.list.vpn import ConfigurationPolicyVPNList, VPNListInfo
 from catalystwan.endpoints.configuration.policy.list.zone import ConfigurationPolicyZoneList, ZoneListInfo
@@ -181,8 +183,8 @@
     SiteList,
     SLAClassList,
     TLOCList,
-    URLBlackList,
-    URLWhiteList,
+    URLAllowList,
+    URLBlockList,
     VPNList,
     ZoneList,
 )
@@ -238,8 +240,8 @@
     SiteList: ConfigurationPolicySiteList,
     SLAClassList: ConfigurationPolicySLAClassList,
     TLOCList: ConfigurationPolicyTLOCList,
-    URLBlackList: ConfigurationPolicyURLBlackList,
-    URLWhiteList: ConfigurationPolicyURLWhiteList,
+    URLBlockList: ConfigurationPolicyURLBlockList,
+    URLAllowList: ConfigurationPolicyURLAllowList,
     VPNList: ConfigurationPolicyVPNList,
     ZoneList: ConfigurationPolicyZoneList,
 }
@@ -498,11 +500,11 @@ def get(self, type: Type[TLOCList]) -> DataSequence[TLOCListInfo]:
         ...
 
     @overload
-    def get(self, type: Type[URLBlackList]) -> DataSequence[URLBlackListInfo]:
+    def get(self, type: Type[URLBlockList]) -> DataSequence[URLBlockListInfo]:
         ...
 
     @overload
-    def get(self, type: Type[URLWhiteList]) -> DataSequence[URLWhiteListInfo]:
+    def get(self, type: Type[URLAllowList]) -> DataSequence[URLAllowListInfo]:
         ...
 
     @overload
@@ -616,11 +618,11 @@ def get(self, type: Type[TLOCList], id: UUID) -> TLOCListInfo:
         ...
 
     @overload
-    def get(self, type: Type[URLBlackList], id: UUID) -> URLBlackListInfo:
+    def get(self, type: Type[URLBlockList], id: UUID) -> URLBlockListInfo:
         ...
 
     @overload
-    def get(self, type: Type[URLWhiteList], id: UUID) -> URLWhiteListInfo:
+    def get(self, type: Type[URLAllowList], id: UUID) -> URLAllowListInfo:
         ...
 
     @overload

catalystwan/api/resource_pool_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/software_action_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/speedtest_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/task_status_api.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/template_api.py

@@ -1,3 +1,5 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import json

catalystwan/api/templates/README.md

@@ -25,14 +25,12 @@ These steps will help you to automate feature template creation. We'll explain w
 	```python
 	from pathlib import Path
 	from typing import ClassVar
+	from pydantic import ConfigDict
 	from catalystwan.api.templates.feature_template import FeatureTemplate
 
 
 	class OMPvSmart(FeatureTemplate):
-		class Config:
-			arbitrary_types_allowed = True
-			allow_population_by_field_name = True
-
+		model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
 		payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
 		type: ClassVar[str] = "omp-vsmart"
@@ -42,15 +40,15 @@ These steps will help you to automate feature template creation. We'll explain w
 	```python
 	ported_templates = (..., OMPvSmart)
 	```
-
+	NOTE: This step will be removed once all template payloads will be generated automatically.
 4. (This step is temporary) Find `available_models` definition in 'supported' and add your new template class.
 	```python
 	available_models = {
 		(...)
 		'omp_vsmart': OMPvSmart
 	}
 	```
-
+	NOTE: This step will be removed once all template payloads will be generated dynamically.
 5. We can try to create our first template with default values.
    ```python
 	omp_vsmart = OMPvSmart(
@@ -67,7 +65,7 @@ These steps will help you to automate feature template creation. We'll explain w
 
 6. We can check whether our template is created sucessfully in Manager manually. If there is an error, please create an issue with error and try go to the 7th step.
 
-### Custimize Feature Template fields.
+### Customize Feature Template fields.
 7. Run below code with already created session and changed corresponding variables.
 
     ```python
@@ -87,8 +85,3 @@ These steps will help you to automate feature template creation. We'll explain w
 
 8. Open `response_{template_type}.json` file.
 9. Find `fields` key. The value should be list of dictionaries. Get every possible key in the dictionary and fill our class with every possible key. You can find the code in `catalystwan\api\templates\models\omp_vsmart_model.py` file.
-
-TODO:
-- Nested fields
-- Handle 3 types of variables
-

catalystwan/api/templates/bool_str.py

@@ -1,3 +1,5 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
 from pydantic import PlainSerializer
 from typing_extensions import Annotated
 

catalystwan/api/templates/cli_template.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import json

catalystwan/api/templates/device_template/device_template.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import logging

catalystwan/api/templates/device_variable.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from pydantic import BaseModel
 
 

catalystwan/api/templates/feature_template.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 import json

catalystwan/api/templates/feature_template_field.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from __future__ import annotations
 
 from enum import Enum

catalystwan/api/templates/feature_template_payload.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from typing import Any, List
 
 from pydantic import BaseModel, ConfigDict, Field

catalystwan/api/templates/models/cisco_aaa_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from pathlib import Path
 from typing import ClassVar, List, Optional

catalystwan/api/templates/models/cisco_banner_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from pathlib import Path
 from typing import ClassVar, Optional
 

catalystwan/api/templates/models/cisco_bfd_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from pathlib import Path
 from typing import ClassVar, List, Optional

catalystwan/api/templates/models/cisco_bgp_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from pathlib import Path
 from typing import ClassVar, List, Optional

catalystwan/api/templates/models/cisco_logging_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from pathlib import Path
 from typing import ClassVar, List, Optional

catalystwan/api/templates/models/cisco_ntp_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from pathlib import Path
 from typing import ClassVar, List, Optional
 

catalystwan/api/templates/models/cisco_omp_model.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 from enum import Enum
 from pathlib import Path
 from typing import ClassVar, List, Optional

catalystwan/api/templates/models/cisco_ospf.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 import ipaddress
 from enum import Enum
 from pathlib import Path

catalystwan/api/templates/models/cisco_ospfv3.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 import ipaddress
 from enum import Enum
 from pathlib import Path

catalystwan/api/templates/models/cisco_secure_internet_gateway.py

@@ -1,3 +1,5 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
 import ipaddress
 from enum import Enum
 from pathlib import Path