Skip to content

P3) (Optoro) Allow variable to be secret in the UI, but gettable in functions, and prevent secret variables from being made non-secret #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RichardDzurus merged 3 commits into from
May 13, 2025
Merged

P3) (Optoro) Allow variable to be secret in the UI, but gettable in functions, and prevent secret variables from being made non-secret #42

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c8731ee
secret -> secrecy - updated python client
RichardDzurus May 7, 2025
c3fd1b6
comment fixed
RichardDzurus May 7, 2025
1a28b45
Merge branch 'develop' into 4131-p3-optoro-allow-variable-to-be-secre…
RichardDzurus May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion polyapi/typedefs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,15 @@ class SpecificationDto(TypedDict):
language: str


# Enum for variable secrecy levels
Secrecy = Literal['SECRET', 'OBSCURED', 'NONE']


class VariableSpecification(TypedDict):
environmentId: str
value: Any
valueType: PropertyType
secret: bool
secrecy: Secrecy


class VariableSpecDto(TypedDict):
Expand Down
7 changes: 4 additions & 3 deletions polyapi/variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
from typing import List

from polyapi.schema import map_primitive_types
from polyapi.typedefs import PropertyType, VariableSpecDto
from polyapi.typedefs import PropertyType, VariableSpecDto, Secrecy
from polyapi.utils import add_import_to_init, init_the_init


# GET is only included if the variable is not a secret
# GET is only included if the variable is not SECRET
GET_TEMPLATE = """
@staticmethod
def get() -> {variable_type}:
Expand Down Expand Up @@ -76,9 +76,10 @@ def generate_variables(variables: List[VariableSpecDto]):

def render_variable(variable: VariableSpecDto):
variable_type = _get_variable_type(variable["variable"]["valueType"])
# Only include get() method if secrecy is not SECRET
get_method = (
""
if variable["variable"]["secret"]
if variable["variable"]["secrecy"] == "SECRET"
else GET_TEMPLATE.format(
variable_id=variable["id"], variable_type=variable_type
)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ requires = ["setuptools>=61.2", "wheel"]

[project]
name = "polyapi-python"
version = "0.3.5.dev1"
version = "0.3.6.dev0"
description = "The Python Client for PolyAPI, the IPaaS by Developers for Developers"
authors = [{ name = "Dan Fellin", email = "dan@polyapi.io" }]
dependencies = [
Expand Down
2 changes: 1 addition & 1 deletion tests/test_variables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
},
"variable": {
"environmentId": "123818231",
"secret": False,
"secrecy": "NONE",
"valueType": {
"kind": "primitive",
"type": "string"
Expand Down