[FLOW-10732] Secrets API #8

jessmand · 2025-01-31T18:45:42Z

Corresponds with https://github.com/instabase/instabase-fern/pull/181

jessmand · 2025-01-31T18:46:14Z

@sayanb06 tagged you for review to make sure everything is correct since you wrote the API!

sayanb06

Couple nits, lgtm otherwise!

sayanb06 · 2025-01-31T18:55:23Z

openapi.yaml

+                  - NONE
+              allowed_workspaces:
+                type: array
+                description: Which workspaces are allowed if only SOME workspaces are allowed.


Can we edit this to be something like:
"If allowed_workspaces_type is SOME, then specify which workspaces in particular. The language is a bit off but it makes it clear that allowed_workspaces_type == SOME

It seems this is also specified in the example so feel free to ignore if not necessary.

sayanb06 · 2025-01-31T18:56:36Z

openapi.yaml

+              alias:
+                type: string
+                description: Name of the secret.
+              description:


There's a list of required props below, I assume this gets integrated into the description in an automated way

Yeah, any parameters not listed as “required” in the special “required” section are listed as “optional” in the parameter descriptions.

sayanb06 · 2025-01-31T18:56:51Z

openapi.yaml

+                  -H "Authorization: Bearer ${API_TOKEN}" \
+                  -H "IB-Context: ${IB_CONTEXT}"\
+                  -F alias="my_secret" \
+                  -F description="Sample secret" \


optional comment

sayanb06 · 2025-01-31T18:57:04Z

openapi.yaml

+
+                result = client.secrets.create(
+                  alias="my_secret",
+                  description="Sample secret",


same as above

sayanb06 · 2025-01-31T18:58:33Z

openapi.yaml

+              description:
+                type: string
+                description: New description of the secret.
+              value:
+                type: string
+                description: New content of the secret.
+              allowed_workspaces_type:
+                type: string
+                description: New designation of which workspaces in this organization are allowed to use this secret in custom functions.
+                enum:
+                  - ALL
+                  - SOME
+                  - NONE
+              allowed_workspaces:
+                type: array
+                description: New designation of which workspaces are allowed if only SOME workspaces are allowed.
+                items:
+                  type: string
+            required:
+              - alias


We should say that this is as needed. If not specified, then the value will stay the same.

sayanb06 · 2025-01-31T19:00:07Z

openapi.yaml

+          description: The user ID of the user who last edited the secret.
+
+/v2/secrets:
+  post:


Do we need to include the GET API? The one above just seems to indicate what the object type returned is. In addition, same question for getting deployed solutions affected by secret.

Ahh crap I must have accidentally deleted it 😢

I was intending on not adding the affected deployments endpoint though

sayanb06

nice! will let others stamp but from an API Perspective, this looks correct

sayanb06 · 2025-01-31T19:23:46Z

openapi.yaml

+      description: |
+        List all secrets available to the organizaiton, in a given workspace, and with a given alias
+
+        <Note>Only organization admins can list all secrets in the organization.</Note>


Can we also add that nonadmins must specify workspace?

cwcowell

Wow, thanks for all the great work on this! Super clear.

cwcowell · 2025-01-31T19:43:46Z

openapi.yaml

+        - secrets
+      summary: List secrets
+      description: |
+        List all secrets available to the organizaiton, in a given workspace, and with a given alias


Suggested change

List all secrets available to the organizaiton, in a given workspace, and with a given alias

List secrets available to the organization, secrets in a given workspace, or secrets with a given alias.

Can you have the same alias defined in two different workspaces, corresponding to different secrets?

If not, maybe use this instead? List secrets available to the organization, secrets available in a given workspace, or the secret with a given alias.

cwcowell · 2025-01-31T19:44:26Z

openapi.yaml

+      description: |
+        List all secrets available to the organizaiton, in a given workspace, and with a given alias
+
+        <Note>Only organization admins can list all secrets in the organization.</Note>


Suggested change

<Note>Only organization admins can list all secrets in the organization.</Note>

<Note>Only organization admins can list all secrets in the organization. Non-admins must specify a workspace.</Note>

cwcowell · 2025-01-31T19:46:54Z

openapi.yaml

+          schema:
+            type: string
+          description: |
+            Filter to secrets in the specified workspace.


Suggested change

Filter to secrets in the specified workspace.

Show secrets defined in the specified workspace.

cwcowell · 2025-01-31T19:48:46Z

openapi.yaml

+          description: |
+            Filter to secrets in the specified workspace.
+
+            <Info>In order to get the secrets for a given workspace, the user must be a member of that workspace.</Info>


Suggested change

<Info>In order to get the secrets for a given workspace, the user must be a member of that workspace.</Info>

<Info>Only members of a workspace can get secrets defined in that workspace.</Info>

cwcowell · 2025-01-31T19:57:28Z

openapi.yaml

+          schema:
+            type: string
+          description: |
+            Get only the secret with the specified alias. 


Suggested change

Get only the secret with the specified alias.

Get the secret with the specified alias.

cwcowell · 2025-01-31T20:28:51Z

openapi.yaml

+              properties:
+                alias:
+                  type: string
+                  description: Name of the secret to be edited.


Suggested change

description: Name of the secret to be edited.

description: Name of the secret to update.

cwcowell · 2025-01-31T20:30:01Z

openapi.yaml

+        - secrets
+      summary: Update secret
+      description: |
+        Update the value, description, or allowed workspaces for a secret.


Suggested change

Update the value, description, or allowed workspaces for a secret.

Update the description, value, or allowed workspaces for a secret.

To preserve the same order as the parameters are listed below.

cwcowell · 2025-01-31T20:30:45Z

openapi.yaml

+                    - NONE
+                allowed_workspaces:
+                  type: array
+                  description: New designation of which workspaces are allowed if only SOME workspaces are allowed.


Suggested change

description: New designation of which workspaces are allowed if only SOME workspaces are allowed.

description: New designation of which workspaces are allowed to use this secret, if only some are.

cwcowell · 2025-01-31T20:32:44Z

openapi.yaml

+              properties:
+                alias:
+                  type: string
+                  description: Name of the secret to be deleted.


Suggested change

description: Name of the secret to be deleted.

description: Name of the secret to delete.

cwcowell · 2025-01-31T20:37:45Z

openapi.yaml

+              alias:
+                type: string
+                description: Name of the secret.
+              description:


Yeah, any parameters not listed as “required” in the special “required” section are listed as “optional” in the parameter descriptions.

jessmand · 2025-02-03T17:28:19Z

openapi.yaml

+        - secrets
+      summary: Update secret
+      description: |
+        Update the description, value, or allowed workspaces for a secret. If a value for a parameter is not specified, it will remain the same.


@cwcowell what do you think of this second sentence I added here?

👍 helpful clarification

anilshanbhag

This looks good to me.

Do you have a PR for addition to SDK/tests already?

anilshanbhag · 2025-02-03T19:26:33Z

We should merge both the main repo PR and this at the same time.

jessmand · 2025-02-03T19:47:19Z

@anilshanbhag I do not yet, trying to get that done today - I might have to backport it. I'll wait to merge this until that's done.

cwcowell · 2025-02-12T18:45:02Z

Checking status on this, so we can merge https://github.com/instabase/instabase-fern/pull/181 at the same time and make sure we put release notes for this change under the correct AI Hub version.

@jessmand are we waiting on the corresponding SDK & tests PR, or is this ready to merge?

cwcowell

LGTM

openapi.yaml

cwcowell · 2025-02-15T00:06:11Z

openapi.yaml

+        - code-samples:
+            - sdk: curl
+              code: |
+                  curl -X PATCH "${API_ROOT}/v2/secrets" \


Wow I’ve never seen PATCH used as an HTTP verb literally ever in my career. 🎉

Co-authored-by: Chris Cowell <43705622+cwcowell@users.noreply.github.com>

jessmand requested review from anilshanbhag, sayanb06 and cwcowell January 31, 2025 18:45

sayanb06 reviewed Jan 31, 2025

View reviewed changes

cwcowell approved these changes Jan 31, 2025

View reviewed changes

jessmand requested a review from cwcowell February 3, 2025 17:27

jessmand commented Feb 3, 2025

View reviewed changes

anilshanbhag reviewed Feb 3, 2025

View reviewed changes

jessmand added 7 commits February 12, 2025 12:36

Post and get secrets

0a27538

PUt and DELETE

9fa5e10

Fix position and add get

e5c33f5

Actually fix it

cb83a31

indent

8e10f99

Indentation fix

8f76bd7

PR comments

68c8958

jessmand force-pushed the flow-10732 branch from 2b3f4b8 to 68c8958 Compare February 12, 2025 19:36

jessmand and others added 2 commits February 13, 2025 19:49

Fix route

ced651d

fix parameter names and request body data type

0937ef4

cwcowell approved these changes Feb 15, 2025

View reviewed changes

Apply suggestions from code review

5f6ba18

Co-authored-by: Chris Cowell <43705622+cwcowell@users.noreply.github.com>

jessmand merged commit 05c2fb4 into master Feb 18, 2025

	List all secrets available to the organizaiton, in a given workspace, and with a given alias
	List secrets available to the organization, secrets in a given workspace, or secrets with a given alias.

	<Note>Only organization admins can list all secrets in the organization.</Note>
	<Note>Only organization admins can list all secrets in the organization. Non-admins must specify a workspace.</Note>

	Filter to secrets in the specified workspace.
	Show secrets defined in the specified workspace.

	<Info>In order to get the secrets for a given workspace, the user must be a member of that workspace.</Info>
	<Info>Only members of a workspace can get secrets defined in that workspace.</Info>

	Get only the secret with the specified alias.
	Get the secret with the specified alias.

	description: Name of the secret to be edited.
	description: Name of the secret to update.

	Update the value, description, or allowed workspaces for a secret.
	Update the description, value, or allowed workspaces for a secret.

	description: New designation of which workspaces are allowed if only SOME workspaces are allowed.
	description: New designation of which workspaces are allowed to use this secret, if only some are.

	description: Name of the secret to be deleted.
	description: Name of the secret to delete.

[FLOW-10732] Secrets API #8

[FLOW-10732] Secrets API #8

Conversation

jessmand commented Jan 31, 2025 • edited Loading

jessmand commented Jan 31, 2025

sayanb06 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sayanb06 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwcowell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwcowell Jan 31, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anilshanbhag left a comment

Choose a reason for hiding this comment

anilshanbhag commented Feb 3, 2025

jessmand commented Feb 3, 2025

cwcowell commented Feb 12, 2025

cwcowell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jessmand commented Jan 31, 2025 •

edited

Loading

cwcowell Jan 31, 2025 •

edited

Loading