From 48cf6a3371bdb33341be19cb3c22e52be8f4c7b4 Mon Sep 17 00:00:00 2001
From: Stephanie Anderson <stephanie.anderson@sentry.io>
Date: Wed, 25 Oct 2023 21:17:01 +0200
Subject: [PATCH 1/2] fetch API docs URL and display in package details box

---
 src/components/platformSdkDetail.tsx                  | 11 ++++++++++-
 src/gatsby/createSchemaCustomization/packageSchema.ts |  1 +
 src/gatsby/sourceNodes/appRegistryNodes.ts            |  1 +
 src/gatsby/sourceNodes/packageRegistryNodes.ts        |  2 ++
 src/gatsby/utils/genericRegistry.ts                   |  1 +
 src/types/platform.tsx                                |  2 +-
 6 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/components/platformSdkDetail.tsx b/src/components/platformSdkDetail.tsx
index 91d4d10fc76ef..4a80952d6fe4d 100644
--- a/src/components/platformSdkDetail.tsx
+++ b/src/components/platformSdkDetail.tsx
@@ -14,6 +14,7 @@ const query = graphql`
         url
         repoUrl
         version
+        apiDocsUrl
       }
     }
   }
@@ -79,7 +80,15 @@ export function PlatformSdkDetail() {
         <dd>{packageData.version}</dd>
         <dt>Repository:</dt>
         <dd>
-          <SmartLink to={packageData.repoUrl} />
+          <SmartLink to={packageData.repoUrl} target="_blank" />
+        </dd>
+        <dt>API Documentation:</dt>
+        <dd>
+          {packageData.apiDocsUrl ? (
+            <SmartLink to={packageData.apiDocsUrl} target="_blank" />
+          ) : (
+            '-'
+          )}
         </dd>
       </dl>
     </PackageDetail>
diff --git a/src/gatsby/createSchemaCustomization/packageSchema.ts b/src/gatsby/createSchemaCustomization/packageSchema.ts
index c2d467b496170..46dedcb41d2cb 100644
--- a/src/gatsby/createSchemaCustomization/packageSchema.ts
+++ b/src/gatsby/createSchemaCustomization/packageSchema.ts
@@ -18,6 +18,7 @@ export const getPackageTypeDefs = () => {
         url: String
         repoUrl: String!
         version: String!
+        apiDocsUrl: String
         files: [PackageFile!]
       }
       `,
diff --git a/src/gatsby/sourceNodes/appRegistryNodes.ts b/src/gatsby/sourceNodes/appRegistryNodes.ts
index e2078641511ca..9777e8292ad3c 100644
--- a/src/gatsby/sourceNodes/appRegistryNodes.ts
+++ b/src/gatsby/sourceNodes/appRegistryNodes.ts
@@ -18,6 +18,7 @@ export const sourceAppRegistryNodes = async ({
       version: appData.version,
       url: appData.package_url,
       repoUrl: appData.repo_url,
+      apiDocsUrl: appData.api_docs_url,
       files: appData.files
         ? Object.entries(appData.files).map(([fileName, fileData]: [string, any]) =>
             fileData.checksums
diff --git a/src/gatsby/sourceNodes/packageRegistryNodes.ts b/src/gatsby/sourceNodes/packageRegistryNodes.ts
index 451c6cbc94005..918d4d228fcfc 100644
--- a/src/gatsby/sourceNodes/packageRegistryNodes.ts
+++ b/src/gatsby/sourceNodes/packageRegistryNodes.ts
@@ -18,6 +18,7 @@ export const sourcePackageRegistryNodes = async ({
       version: sdkData.version,
       url: sdkData.package_url,
       repoUrl: sdkData.repo_url,
+      apiDocsUrl: sdkData.api_docs_url,
       files: sdkData.files
         ? Object.entries(sdkData.files).map(([fileName, fileData]: [string, any]) =>
             fileData.checksums
@@ -34,6 +35,7 @@ export const sourcePackageRegistryNodes = async ({
     };
 
     const content = JSON.stringify(data);
+
     const nodeMeta = {
       id: sdkName,
       parent: null,
diff --git a/src/gatsby/utils/genericRegistry.ts b/src/gatsby/utils/genericRegistry.ts
index d485e828f2ed8..98c99da6c5260 100644
--- a/src/gatsby/utils/genericRegistry.ts
+++ b/src/gatsby/utils/genericRegistry.ts
@@ -13,6 +13,7 @@ type VersionData = {
   name: string;
   repo_url: string;
   version: string;
+  api_docs_url?: string;
   files?: {
     [name: string]: FileData;
   };
diff --git a/src/types/platform.tsx b/src/types/platform.tsx
index faa3a55aeb510..8741f7830ce54 100644
--- a/src/types/platform.tsx
+++ b/src/types/platform.tsx
@@ -14,7 +14,7 @@ export interface Platform extends PlatformConfig {
    */
   key: string;
   /**
-   * Same as key. Use `title` for a human readable platform name.
+   * Same as key. Use `title` for a human-readable platform name.
    *
    * @see Platform.key
    */

From 29b81a85b545047d2e0246baec8b601f0066176d Mon Sep 17 00:00:00 2001
From: Abhijeet Prasad <aprasad@sentry.io>
Date: Wed, 25 Oct 2023 15:45:45 -0400
Subject: [PATCH 2/2] only display api docs if it exists

---
 src/components/platformSdkDetail.tsx | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/src/components/platformSdkDetail.tsx b/src/components/platformSdkDetail.tsx
index 4a80952d6fe4d..a69f0c8a1f171 100644
--- a/src/components/platformSdkDetail.tsx
+++ b/src/components/platformSdkDetail.tsx
@@ -1,4 +1,4 @@
-import React from 'react';
+import React, {Fragment} from 'react';
 import styled from '@emotion/styled';
 import {graphql, useStaticQuery} from 'gatsby';
 
@@ -82,14 +82,14 @@ export function PlatformSdkDetail() {
         <dd>
           <SmartLink to={packageData.repoUrl} target="_blank" />
         </dd>
-        <dt>API Documentation:</dt>
-        <dd>
-          {packageData.apiDocsUrl ? (
-            <SmartLink to={packageData.apiDocsUrl} target="_blank" />
-          ) : (
-            '-'
-          )}
-        </dd>
+        {packageData.apiDocsUrl && (
+          <Fragment>
+            <dt>API Documentation:</dt>
+            <dd>
+              <SmartLink to={packageData.apiDocsUrl} target="_blank" />
+            </dd>
+          </Fragment>
+        )}
       </dl>
     </PackageDetail>
   );