@stainless-api/docs 0.1.0-beta.96 → 0.1.0-beta.98

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.98
+
+### Minor Changes
+
+- ba39673: Makes sidebar keys truly unique
+
+## 0.1.0-beta.97
+
+### Patch Changes
+
+- 415629f: Allow displaying a user-provided snippet as the “default” in single-snippet
+- Updated dependencies [415629f]
+  - @stainless-api/docs-ui@0.1.0-beta.74
+  - @stainless-api/docs-search@0.1.0-beta.27
+
 ## 0.1.0-beta.96
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.96",
+  "version": "0.1.0-beta.98",
   "publishConfig": {
     "access": "public"
   },
@@ -56,8 +56,8 @@
     "vite-plugin-prebundle-workers": "^0.2.0",
     "web-worker": "^1.5.0",
     "yaml": "^2.8.2",
-    "@stainless-api/docs-search": "0.1.0-beta.26",
-    "@stainless-api/docs-ui": "0.1.0-beta.73",
+    "@stainless-api/docs-search": "0.1.0-beta.27",
+    "@stainless-api/docs-ui": "0.1.0-beta.74",
     "@stainless-api/ui-primitives": "0.1.0-beta.47"
   },
   "devDependencies": {

package/plugin/sidebar-utils/sidebar-builder.ts

@@ -2,6 +2,19 @@ import type * as SDKJSON from '@stainless/sdk-json';
 import { generateRoute, walkTree, type DocsLanguage } from '@stainless-api/docs-ui/routing';
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 
+function makeMethodOrResourceKey(entry: SDKJSON.Method | SDKJSON.Resource): string {
+  if (entry.kind === 'http_method') {
+    if (entry.endpoint && entry.endpoint !== '') {
+      return entry.endpoint;
+    }
+    return entry.stainlessPath;
+  }
+  if (entry.kind === 'resource') {
+    return entry.stainlessPath;
+  }
+  throw new Error(`Unknown entry kind ${JSON.stringify(entry)}`);
+}
+
 function isResourceNonEmpty(resource: SDKJSON.Resource) {
   return (
     Object.keys(resource.methods ?? {}).length > 0 ||
@@ -174,7 +187,7 @@ export class SidebarConfigItemsBuilder {
     return {
       kind: 'resource_overview_page',
       label: this.isWebhookResource(entry) ? 'Events' : 'Overview',
-      key: entry.configRef,
+      key: makeMethodOrResourceKey(entry),
       badge: undefined,
       metadata: {
         subResourceCount: countKeys(entry.subresources),
@@ -188,7 +201,7 @@ export class SidebarConfigItemsBuilder {
     return {
       kind: 'method_page',
       label: entry.title,
-      key: entry.endpoint,
+      key: makeMethodOrResourceKey(entry),
       badge: undefined,
       metadata: {
         deprecated: Boolean(entry.deprecated),
@@ -230,7 +243,7 @@ export class SidebarConfigItemsBuilder {
       kind: 'group',
       badge: undefined,
       label: resource.title,
-      resourceGroupKey: resource.configRef,
+      resourceGroupKey: makeMethodOrResourceKey(resource),
       entries,
       collapsed,
     };
@@ -268,10 +281,10 @@ type SidebarEntry = StarlightRouteData['sidebar'][number];
 
 function getResourceOrMethod(spec: SDKJSON.Spec, endpointOrConfigRef: string) {
   for (const entry of walkTree(spec, false)) {
-    if (entry.data.kind === 'resource' && entry.data.configRef === endpointOrConfigRef) {
-      return entry;
+    if (entry.data.kind === 'model') {
+      continue;
     }
-    if (entry.data.kind === 'http_method' && entry.data.endpoint === endpointOrConfigRef) {
+    if (makeMethodOrResourceKey(entry.data) === endpointOrConfigRef) {
       return entry;
     }
   }