improvement: make sdk version optional and default to latest (#734)

fern/apis/fdr/definition/snippets.yml

@@ -30,7 +30,7 @@ service:
               docs: |
                 If you have more than one API, you must specify its ID.
             sdks:
-              type: optional<list<SDK>>
+              type: optional<list<SDKRequest>>
               docs: |
                 The SDKs for which to load snippets. If unspecified,
                 snippets for the latest published SDKs will be returned.
@@ -116,7 +116,7 @@ service:
               docs: |
                 If you have more than one API, you must specify its ID.
             sdks:
-              type: optional<list<SDK>>
+              type: optional<list<SDKRequest>>
               docs: |
                 The SDKs for which to load snippets. If unspecified,
                 snippets for the latest published SDKs will be returned.
@@ -140,7 +140,7 @@ service:
             sdks:
               - type: python
                 package: vellum-ai
-                version: 1.2.1
+                # version: 1.2.1
           response:
             body:
               next: 2
@@ -206,6 +206,41 @@ service:
                         })
 
 types:
+  SDKRequest:
+    base-properties:
+      version: optional<string>
+    union:
+      typescript: TypeScriptSDKRequest
+      python: PythonSDKRequest
+      go: GoSDKRequest
+      ruby: RubySDKRequest
+      java: JavaSDKRequest
+
+  TypeScriptSDKRequest:
+    properties:
+      package: string
+
+  PythonSDKRequest:
+    properties:
+      package: string
+
+  GoSDKRequest:
+    properties:
+      githubRepo: string
+
+  RubySDKRequest:
+    properties:
+      gem: string
+
+  JavaSDKRequest:
+    properties:
+      group:
+        type: string
+        docs: The maven repository group (e.g. `com.stripe.java`)
+      artifact:
+        type: string
+        docs: The artifact (e.g. `stripe-java`)
+
   SDK:
     union:
       typescript: TypeScriptSDK

fern/apis/fdr/definition/templates.yml

@@ -70,7 +70,7 @@ service:
               type: commons.ApiId
               docs: |
                 The API name.
-            sdk: snippets.SDK
+            sdk: snippets.SDKRequest
             endpointId: commons.EndpointIdentifier
       response: EndpointSnippetTemplate
 

packages/fdr-sdk/src/client/generated/api/resources/snippets/client/requests/GetSnippetRequest.ts

@@ -30,7 +30,7 @@ export interface GetSnippetRequest {
      * snippets for the latest published SDKs will be returned.
      *
      */
-    sdks?: FernRegistry.Sdk[];
+    sdks?: FernRegistry.SdkRequest[];
     endpoint: FernRegistry.EndpointIdentifier;
     /**
      * The JSON payload to be used as the input for the code snippet. This should just be thought of as the

packages/fdr-sdk/src/client/generated/api/resources/snippets/client/requests/ListSnippetsRequest.ts

@@ -12,8 +12,7 @@ import * as FernRegistry from "../../../..";
  *         apiId: "vellum-ai",
  *         sdks: [{
  *                 type: "python",
- *                 package: "vellum-ai",
- *                 version: "1.2.1"
+ *                 package: "vellum-ai"
  *             }]
  *     }
  */
@@ -35,5 +34,5 @@ export interface ListSnippetsRequest {
      * snippets for the latest published SDKs will be returned.
      *
      */
-    sdks?: FernRegistry.Sdk[];
+    sdks?: FernRegistry.SdkRequest[];
 }

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/GoSdkRequest.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface GoSdkRequest {
+    githubRepo: string;
+}

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/JavaSdkRequest.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface JavaSdkRequest {
+    /** The maven repository group (e.g. `com.stripe.java`) */
+    group: string;
+    /** The artifact (e.g. `stripe-java`) */
+    artifact: string;
+}

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/PythonSdkRequest.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface PythonSdkRequest {
+    package: string;
+}

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/RubySdkRequest.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface RubySdkRequest {
+    gem: string;
+}

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/SdkRequest.ts

@@ -0,0 +1,38 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+import * as FernRegistry from "../../..";
+
+export type SdkRequest =
+    | FernRegistry.SdkRequest.Typescript
+    | FernRegistry.SdkRequest.Python
+    | FernRegistry.SdkRequest.Go
+    | FernRegistry.SdkRequest.Ruby
+    | FernRegistry.SdkRequest.Java;
+
+export declare namespace SdkRequest {
+    interface Typescript extends FernRegistry.TypeScriptSdkRequest, _Base {
+        type: "typescript";
+    }
+
+    interface Python extends FernRegistry.PythonSdkRequest, _Base {
+        type: "python";
+    }
+
+    interface Go extends FernRegistry.GoSdkRequest, _Base {
+        type: "go";
+    }
+
+    interface Ruby extends FernRegistry.RubySdkRequest, _Base {
+        type: "ruby";
+    }
+
+    interface Java extends FernRegistry.JavaSdkRequest, _Base {
+        type: "java";
+    }
+
+    interface _Base {
+        version?: string;
+    }
+}

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/TypeScriptSdkRequest.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+export interface TypeScriptSdkRequest {
+    package: string;
+}

packages/fdr-sdk/src/client/generated/api/resources/snippets/types/index.ts

@@ -1,3 +1,9 @@
+export * from "./SdkRequest";
+export * from "./TypeScriptSdkRequest";
+export * from "./PythonSdkRequest";
+export * from "./GoSdkRequest";
+export * from "./RubySdkRequest";
+export * from "./JavaSdkRequest";
 export * from "./Sdk";
 export * from "./TypeScriptSdk";
 export * from "./PythonSdk";

packages/fdr-sdk/src/client/generated/api/resources/templates/client/requests/GetSnippetTemplate.ts

@@ -15,6 +15,6 @@ export interface GetSnippetTemplate {
      *
      */
     apiId: FernRegistry.ApiId;
-    sdk: FernRegistry.Sdk;
+    sdk: FernRegistry.SdkRequest;
     endpointId: FernRegistry.EndpointIdentifier;
 }

servers/fdr/src/__test__/local/services/snippetTemplates.test.ts

@@ -2,7 +2,7 @@ import { FdrAPI } from "@fern-api/fdr-sdk";
 import { inject } from "vitest";
 import { FernRegistry } from "../../../api/generated";
 import { CHAT_COMPLETION_PAYLOAD, CHAT_COMPLETION_SNIPPET } from "../../octo";
-import { getClient } from "../util";
+import { getAPIResponse, getClient } from "../util";
 
 const ENDPOINT: FdrAPI.EndpointIdentifier = {
     path: "/users/v1",
@@ -71,23 +71,89 @@ it("generate example from snippet template", async () => {
         orgId,
         apiId,
         apiDefinitionId: "....",
-        snippet: CHAT_COMPLETION_SNIPPET,
+        snippet: CHAT_COMPLETION_SNIPPET("0.0.5"),
     });
     // create snippets
     await fdr.templates.get({
         orgId,
         apiId,
-        endpointId: CHAT_COMPLETION_SNIPPET.endpointId,
+        endpointId: CHAT_COMPLETION_SNIPPET("0.0.5").endpointId,
         sdk,
     });
 
     const response = await fdr.snippets.get({
         orgId,
         apiId,
-        endpoint: CHAT_COMPLETION_SNIPPET.endpointId,
+        endpoint: CHAT_COMPLETION_SNIPPET("0.0.5").endpointId,
         sdks: [sdk],
         payload: CHAT_COMPLETION_PAYLOAD,
     });
     expect(response.ok).toBe(true);
     console.log(JSON.stringify(response, null, 2));
 });
+
+it("fallback to version", async () => {
+    const unauthedFdr = getClient({ authed: false, url: inject("url") });
+    const fdr = getClient({ authed: true, url: inject("url") });
+
+    const orgId = "octoai";
+    const apiId = "api";
+    const sdk: FernRegistry.Sdk = {
+        type: "python",
+        package: "octoai",
+        version: "0.0.6",
+    };
+    const genericRequest: FernRegistry.SdkRequest = {
+        type: "python",
+        package: "octoai",
+    };
+
+    // register API definition for acme org
+    const reg = await unauthedFdr.templates.register({
+        orgId,
+        apiId,
+        apiDefinitionId: "....",
+        snippet: CHAT_COMPLETION_SNIPPET("0.0.6"),
+    });
+    expect(reg.ok).toBe(true);
+    // create snippets
+    const template = getAPIResponse(
+        await fdr.templates.get({
+            orgId,
+            apiId,
+            endpointId: CHAT_COMPLETION_SNIPPET("0.0.6").endpointId,
+            sdk: genericRequest,
+        }),
+    );
+    expect(template.sdk.version).toBe("0.0.6");
+
+    // register API definition for acme org
+    const regAgain = await unauthedFdr.templates.register({
+        orgId,
+        apiId,
+        apiDefinitionId: "....",
+        snippet: CHAT_COMPLETION_SNIPPET("0.0.122"),
+    });
+    expect(regAgain.ok).toBe(true);
+    // create snippets
+    const templateAgain = getAPIResponse(
+        await fdr.templates.get({
+            orgId,
+            apiId,
+            endpointId: CHAT_COMPLETION_SNIPPET("0.0.122").endpointId,
+            sdk: genericRequest,
+        }),
+    );
+    expect(templateAgain.sdk.version).toBe("0.0.122");
+
+    const templateSpecify = await fdr.templates.get({
+        orgId,
+        apiId,
+        endpointId: CHAT_COMPLETION_SNIPPET("0.0.6").endpointId,
+        sdk,
+    });
+    expect(templateSpecify.ok).toBe(true);
+    if (templateSpecify.ok) {
+        expect(templateSpecify.body.sdk.version).toBe("0.0.6");
+    }
+});

servers/fdr/src/__test__/octo.ts

@@ -1,14 +1,14 @@
 import { FdrAPI } from "@fern-api/fdr-sdk";
 
-export const CHAT_COMPLETION_SNIPPET: FdrAPI.EndpointSnippetTemplate = {
+export const CHAT_COMPLETION_SNIPPET = (version: string): FdrAPI.EndpointSnippetTemplate => ({
     endpointId: {
         path: "/v1/chat/completions",
         method: "POST",
     },
     sdk: {
         type: "python",
         package: "octoai",
-        version: "0.0.5",
+        version,
     },
     snippetTemplate: {
         type: "v1",
@@ -624,7 +624,7 @@ export const CHAT_COMPLETION_SNIPPET: FdrAPI.EndpointSnippetTemplate = {
         clientInstantiation:
             'from octoai.client import AsyncOctoAI\n\nclient = AsyncOctoAI(\n    api_key="YOUR_API_KEY",\n)\n',
     },
-};
+});
 
 export const CHAT_COMPLETION_PAYLOAD: FdrAPI.CustomSnippetPayload = {
     headers: [],

servers/fdr/src/api/generated/api/resources/snippets/service/requests/GetSnippetRequest.d.ts

@@ -5,7 +5,7 @@ import * as FernRegistry from "../../../..";
 export interface GetSnippetRequest {
     orgId?: FernRegistry.OrgId;
     apiId?: FernRegistry.ApiId;
-    sdks?: FernRegistry.Sdk[];
+    sdks?: FernRegistry.SdkRequest[];
     endpoint: FernRegistry.EndpointIdentifier;
     payload?: FernRegistry.CustomSnippetPayload;
 }

servers/fdr/src/api/generated/api/resources/snippets/service/requests/ListSnippetsRequest.d.ts

@@ -5,5 +5,5 @@ import * as FernRegistry from "../../../..";
 export interface ListSnippetsRequest {
     orgId?: FernRegistry.OrgId;
     apiId?: FernRegistry.ApiId;
-    sdks?: FernRegistry.Sdk[];
+    sdks?: FernRegistry.SdkRequest[];
 }

servers/fdr/src/api/generated/api/resources/snippets/types/GoSdkRequest.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface GoSdkRequest {
+    githubRepo: string;
+}

servers/fdr/src/api/generated/api/resources/snippets/types/GoSdkRequest.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

servers/fdr/src/api/generated/api/resources/snippets/types/JavaSdkRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface JavaSdkRequest {
+    /** The maven repository group (e.g. `com.stripe.java`) */
+    group: string;
+    /** The artifact (e.g. `stripe-java`) */
+    artifact: string;
+}

servers/fdr/src/api/generated/api/resources/snippets/types/JavaSdkRequest.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

servers/fdr/src/api/generated/api/resources/snippets/types/PythonSdkRequest.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface PythonSdkRequest {
+    package: string;
+}

servers/fdr/src/api/generated/api/resources/snippets/types/PythonSdkRequest.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

servers/fdr/src/api/generated/api/resources/snippets/types/RubySdkRequest.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface RubySdkRequest {
+    gem: string;
+}

servers/fdr/src/api/generated/api/resources/snippets/types/RubySdkRequest.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};