[codex] Clean up OpenAPI add source API (#843)

* Clean up OpenAPI add source API * Update OpenAPI add source credential UI * Address OpenAPI add source PR feedback * Document OpenAPI credential configuration plan * Fix OpenAPI add flow CI

Rhys Sullivan committed 6 months ago

Commit 529a54f1 parent 1d16b0b20 files · +1477 −467Browse files

Showing the changes to packages/plugins/openapi/src/api (2 of 20 files). Show all

Unified · Split

2 files

packages/plugins/openapi/src/api/group.ts +23 −31
packages/plugins/openapi/src/api/handlers.ts +11 −14

packages/plugins/openapi/src/api/group.ts+23−31

 import { HttpApiEndpoint, HttpApiGroup } from "effect/unstable/httpapi";
 import { Schema } from "effect";
-import {
+import { InternalError, ScopeId, SecretBackedValue } from "@executor-js/sdk/shared";
-  InternalError,
-  ScopeId,
-  ScopedSecretCredentialInput,
-  SecretBackedValue,
-} from "@executor-js/sdk/shared";
 import { OpenApiParseError, OpenApiExtractionError, OpenApiOAuthError } from "../sdk/errors";
 import { SpecPreview } from "../sdk/preview";
   sourceScopeId: ScopeId,
 };
-const SpecFetchCredentialsPayload = Schema.Struct({
+const OpenApiSpecInputPayload = Schema.Union([
+  Schema.Struct({ kind: Schema.Literal("url"), url: Schema.String }),
+  Schema.Struct({ kind: Schema.Literal("blob"), value: Schema.String }),
+]);
+const PreviewSpecFetchCredentialsPayload = Schema.Struct({
   headers: Schema.optional(Schema.Record(Schema.String, SecretBackedValue)),
   queryParams: Schema.optional(Schema.Record(Schema.String, SecretBackedValue)),
 });
-const ConfiguredCredentialBindingPayload = Schema.Struct({
+const OpenApiSecretShapePayload = Schema.Struct({
-  kind: Schema.Literal("binding"),
+  kind: Schema.Literal("secret"),
-  slot: Schema.String,
   prefix: Schema.optional(Schema.String),
 });
-const ConfiguredCredentialValuePayload = Schema.Union([
+const OpenApiConfiguredValuePayload = Schema.Union([Schema.String, OpenApiSecretShapePayload]);
-  Schema.String,
-  ConfiguredCredentialBindingPayload,
-]);
-const OpenApiCredentialInputPayload = Schema.Union([
+const SpecFetchCredentialsPayload = Schema.Struct({
-  ScopedSecretCredentialInput,
+  headers: Schema.optional(Schema.Record(Schema.String, OpenApiConfiguredValuePayload)),
-  SecretBackedValue,
+  queryParams: Schema.optional(Schema.Record(Schema.String, OpenApiConfiguredValuePayload)),
-  ConfiguredCredentialValuePayload,
+});
-]);
 // ---------------------------------------------------------------------------
 // Payloads
 // ---------------------------------------------------------------------------
 const AddSpecPayload = Schema.Struct({
-  targetScope: ScopeId,
+  spec: OpenApiSpecInputPayload,
-  credentialTargetScope: Schema.optional(ScopeId),
-  spec: Schema.String,
   specFetchCredentials: Schema.optional(SpecFetchCredentialsPayload),
-  name: Schema.optional(Schema.String),
+  name: Schema.String,
-  baseUrl: Schema.optional(Schema.String),
+  baseUrl: Schema.String,
-  namespace: Schema.optional(Schema.String),
+  namespace: Schema.String,
-  headers: Schema.optional(Schema.Record(Schema.String, OpenApiCredentialInputPayload)),
+  headers: Schema.optional(Schema.Record(Schema.String, OpenApiConfiguredValuePayload)),
-  queryParams: Schema.optional(Schema.Record(Schema.String, OpenApiCredentialInputPayload)),
+  queryParams: Schema.optional(Schema.Record(Schema.String, OpenApiConfiguredValuePayload)),
   oauth2: Schema.optional(OAuth2SourceConfig),
 });
 const PreviewSpecPayload = Schema.Struct({
   spec: Schema.String,
-  specFetchCredentials: Schema.optional(SpecFetchCredentialsPayload),
+  specFetchCredentials: Schema.optional(PreviewSpecFetchCredentialsPayload),
 });
 const UpdateSourcePayload = Schema.Struct({
   sourceScope: ScopeId,
   name: Schema.optional(Schema.String),
   baseUrl: Schema.optional(Schema.String),
-  headers: Schema.optional(Schema.Record(Schema.String, OpenApiCredentialInputPayload)),
+  headers: Schema.optional(Schema.Record(Schema.String, OpenApiConfiguredValuePayload)),
-  queryParams: Schema.optional(Schema.Record(Schema.String, OpenApiCredentialInputPayload)),
+  queryParams: Schema.optional(Schema.Record(Schema.String, OpenApiConfiguredValuePayload)),
-  credentialTargetScope: Schema.optional(ScopeId),
   // Set after a successful re-authenticate to refresh the source's
   // stored OAuth2 metadata.
   oauth2: Schema.optional(OAuth2SourceConfig),

packages/plugins/openapi/src/api/handlers.ts+11−14

 import { addGroup, capture } from "@executor-js/api";
 import type {
-  ConfiguredHeaderValue,
+  OpenApiConfiguredValueInput,
   OpenApiPluginExtension,
-  HeaderValue,
+  OpenApiPreviewSpecFetchCredentialsInput,
-  OpenApiCredentialInput,
   OpenApiSpecFetchCredentialsInput,
   OpenApiUpdateSourceInput,
 } from "../sdk/plugin";
           return yield* ext.previewSpec({
             spec: payload.spec,
             specFetchCredentials: payload.specFetchCredentials as
-              | OpenApiSpecFetchCredentialsInput
+              | OpenApiPreviewSpecFetchCredentialsInput
               | undefined,
           });
         }),
       ),
     )
-    .handle("addSpec", ({ payload }) =>
+    .handle("addSpec", ({ params: path, payload }) =>
       capture(
         Effect.gen(function* () {
           const ext = yield* OpenApiExtensionService;
             specFetchCredentials: payload.specFetchCredentials as
               | OpenApiSpecFetchCredentialsInput
               | undefined,
-            scope: payload.targetScope,
+            scope: path.scopeId,
             name: payload.name,
             baseUrl: payload.baseUrl,
             namespace: payload.namespace,
-            credentialTargetScope: payload.credentialTargetScope,
+            headers: payload.headers as Record<string, OpenApiConfiguredValueInput> | undefined,
-            headers: payload.headers as
+            queryParams: payload.queryParams as
-              | Record<string, HeaderValue | ConfiguredHeaderValue>
+              | Record<string, OpenApiConfiguredValueInput>
               | undefined,
-            queryParams: payload.queryParams as Record<string, OpenApiCredentialInput> | undefined,
             oauth2: payload.oauth2,
           });
           return {
           yield* ext.updateSource(path.namespace, payload.sourceScope, {
             name: payload.name,
             baseUrl: payload.baseUrl,
-            headers: payload.headers as
+            headers: payload.headers as Record<string, OpenApiConfiguredValueInput> | undefined,
-              | Record<string, HeaderValue | ConfiguredHeaderValue>
+            queryParams: payload.queryParams as
+              | Record<string, OpenApiConfiguredValueInput>
               | undefined,
-            queryParams: payload.queryParams as Record<string, OpenApiCredentialInput> | undefined,
-            credentialTargetScope: payload.credentialTargetScope,
             oauth2: payload.oauth2,
           } as OpenApiUpdateSourceInput);
           return { updated: true };