chore: modify fdr apis to accomodate openapi parser for docs generati…

…on (#1901)
fern-api · Dec 17, 2024 · c2eb745 · c2eb745
1 parent 5e454f5
commit c2eb745
Show file tree

Hide file tree

Showing 55 changed files with 1,145 additions and 152 deletions.
diff --git a/fern/apis/fdr/definition/api/latest/__package__.yml b/fern/apis/fdr/definition/api/latest/__package__.yml
@@ -9,6 +9,21 @@ imports:
   rootCommons: ../../commons.yml
   auth: auth.yml
 
+service:
+  base-path: /registry/api/latest
+  auth: true
+  audiences:
+    - read
+  endpoints:
+    getApiLatest:
+      method: GET
+      path: /load/{apiDefinitionId}
+      path-parameters:
+        apiDefinitionId: rootCommons.ApiDefinitionId
+      response: ApiDefinition
+      errors:
+        - ApiDoesNotExistError
+
 types:
   ApiDefinition:
     properties:
@@ -20,3 +35,7 @@ types:
       subpackages: map<commons.SubpackageId, commons.SubpackageMetadata>
       auths: map<auth.AuthSchemeId, auth.AuthScheme>
       globalHeaders: optional<list<type.ObjectProperty>>
+
+errors:
+  ApiDoesNotExistError:
+    status-code: 404
diff --git a/fern/apis/fdr/definition/api/v1/register/__package__.yml b/fern/apis/fdr/definition/api/v1/register/__package__.yml
@@ -5,6 +5,7 @@ imports:
   type: type.yml
   rootCommons: ../../../commons.yml
   commons: ../commons.yml
+  latest: ../../latest/__package__.yml
   webhook: webhook.yml
   websocket: websocket.yml
 
@@ -23,7 +24,8 @@ service:
           properties:
             orgId: rootCommons.OrgId
             apiId: rootCommons.ApiId
-            definition: ApiDefinition
+            definition: optional<ApiDefinition>
+            definitionV2: optional<latest.ApiDefinition>
             sources: optional<map<SourceId, Source>>
       response: RegisterApiDefinitionResponse
       errors:

diff --git a/fern/apis/fdr/definition/docs/v1/read/__package__.yml b/fern/apis/fdr/definition/docs/v1/read/__package__.yml
@@ -4,6 +4,7 @@ imports:
   algolia: ../../../algolia.yml
   rootCommons: ../../../commons.yml
   apiReadV1: ../../../api/v1/read/__package__.yml
+  apiReadLatest: ../../../api/latest/__package__.yml
   apiCommonsV1: ../../../api/v1/commons.yml
   commons: ../commons/commons.yml
   navigationV1: ../../../navigation/v1/__package__.yml
@@ -67,6 +68,7 @@ types:
       algoliaSearchIndex: optional<algolia.AlgoliaSearchIndex>
       pages: map<rootCommons.PageId, PageContent>
       apis: map<rootCommons.ApiDefinitionId, apiReadV1.ApiDefinition>
+      apisV2: map<rootCommons.ApiDefinitionId, apiReadLatest.ApiDefinition>
       files: map<rootCommons.FileId, rootCommons.Url>
       filesV2: map<rootCommons.FileId, File>
       jsFiles:

diff --git a/packages/commons/fdr-utils/src/definition-object-factory.ts b/packages/commons/fdr-utils/src/definition-object-factory.ts
@@ -5,6 +5,7 @@ export class DefinitionObjectFactory {
         return {
             pages: {},
             apis: {},
+            apisV2: {},
             files: {},
             filesV2: {},
             config: {

diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/client/Client.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/client/Client.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/client/Client.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/client/Client.ts
diff --git a/...es/fdr-sdk/src/client/generated/api/resources/api/resources/latest/client/getApiLatest.ts b/...es/fdr-sdk/src/client/generated/api/resources/api/resources/latest/client/getApiLatest.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/client/index.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/client/index.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/index.ts b/packages/fdr-sdk/src/client/generated/api/resources/api/resources/latest/index.ts