Added additional attributes to the connector credentials & example

Author: SteveMcGrath

.gitignore

@@ -8,3 +8,4 @@ __pycache__
 .secrets
 requirements.txt
 /example
+job.log

tenint/__init__.py

@@ -2,4 +2,4 @@
 from .models.configuration import Configuration, Settings  # noqa F401
 from .connector import Connector  # noqa F401
 
-__version__ = "1.0.2"
+__version__ = "1.0.3"

tenint/models/credentials.py

@@ -1,6 +1,6 @@
-from typing import Any, Literal
+from typing import Annotated, Any, Literal
 
-from pydantic import AnyHttpUrl, BaseModel, ConfigDict, SecretStr, computed_field
+from pydantic import AnyHttpUrl, BaseModel, ConfigDict, Field, SecretStr, computed_field
 
 
 def credential_schema(schema: dict[str, Any]) -> None:
@@ -50,9 +50,21 @@ class TenableCloudCredential(Credential):
     name: Literal["Tenable Cloud"] = "Tenable Cloud"
     slug: Literal["tvm"] = "tvm"
     description: str = "Tenable Cloud Credential"
-    url: AnyHttpUrl = "https://cloud.tenable.com"
-    access_key: str
-    secret_key: SecretStr
+    url: Annotated[
+        AnyHttpUrl,
+        Field(
+            title="Cloud URL",
+            description="Only needs to be modified when interacting with a FedRAMP cloud instance",
+        ),
+    ] = "https://cloud.tenable.com"
+    access_key: Annotated[
+        str,
+        Field(title="API Access Key", description="Tenable Cloud API Access Key"),
+    ]
+    secret_key: Annotated[
+        SecretStr,
+        Field(title="API Secret Key", description="Tenable Cloud API Secret Key"),
+    ]
 
 
 class TenableSCCredential(Credential):
@@ -64,6 +76,15 @@ class TenableSCCredential(Credential):
     name: Literal["Tenable Security Center"] = "Tenable Security Center"
     slug: Literal["tsc"] = "tsc"
     description: str = "Tenable Security Center Credential"
-    url: AnyHttpUrl
-    access_key: str
-    secret_key: SecretStr
+    url: Annotated[
+        AnyHttpUrl,
+        Field(title="Host URL", description="Security Center Application URL"),
+    ]
+    access_key: Annotated[
+        str,
+        Field(title="API Access Key", description="Security Center API Access Key"),
+    ]
+    secret_key: Annotated[
+        SecretStr,
+        Field(title="API Secret Key", description="Security Center API Secret Key"),
+    ]

tenint/templates/connector.py

@@ -1,6 +1,7 @@
 import logging
+from typing import Annotated
 
-from pydantic import AnyHttpUrl
+from pydantic import AnyHttpUrl, Field
 
 from tenint import Connector, Credential, Settings
 
@@ -9,12 +10,21 @@ class TestCredential(Credential):
     prefix: str = "test"
     name: str = "Test Credential"
     slug: str = "test"
-    api_key: str
-    url: AnyHttpUrl = "https://httpbin.org/get"
+    api_key: Annotated[
+        str,
+        Field(title="API Key", description="Application API Key"),
+    ]
+    url: Annotated[
+        AnyHttpUrl,
+        Field(title="Application URL", description="Application URL"),
+    ] = "https://httpbin.org/get"
 
 
 class AppSettings(Settings):
-    is_bool: bool = True
+    is_bool: Annotated[
+        bool,
+        Field(title="Yes?", description="An example boolean flag"),
+    ] = True
 
 
 log = logging.getLogger("test-connector")