fix(cli): changelog IDs are now unique within a section (#4725)

packages/cli/cli/versions.yml

@@ -1,6 +1,18 @@
 - changelogEntry:
     - summary: |
-        The OpenAPI importer now correctly propagates the title field on `oneof` schemas. 
+        The documentation resolver now approrpiately creates a unique identifier for changelog sections. Previously, if you had multiple
+        changelogs within the same section, despite their title and slug being different, they would be treated as the same section since the ID
+        only took into account the parents' slug, appended the word "changelog" and that was all.
+
+        As a result previously all changelogs within the same section would get highlighted when one was selected, now only the selected changelog
+        is highlighted.
+      type: internal
+  irVersion: 53
+  version: 0.42.15
+
+- changelogEntry:
+    - summary: |
+        The OpenAPI importer now correctly propagates the title field on `oneof` schemas.
       type: fix
   irVersion: 53
   version: 0.42.14
@@ -13,44 +25,44 @@
   irVersion: 53
   version: 0.42.13
 
-- changelogEntry: 
-    - summary: | 
+- changelogEntry:
+    - summary: |
         Previously, deploying docs from Windows machines led to bad asset paths.
         Now, the CLI respects Windows paths during run and web paths for retrieving
         assets.
       type: fix
   irVersion: 53
   version: 0.42.12
 
-- changelogEntry: 
-    - summary: | 
-        The API V2 configuration now supports disabling using titles as schema 
+- changelogEntry:
+    - summary: |
+        The API V2 configuration now supports disabling using titles as schema
         names. You may want to disable this flag if your OpenAPI adds the same
-        title to multiple schemas. 
+        title to multiple schemas.
 
         ```
-        api: 
-          specs: 
+        api:
+          specs:
             - openapi: /path/to/openapi
-              settings: 
+              settings:
                 use-title-as-schema-name: false
         ```
       type: fix
   irVersion: 53
   version: 0.42.11
 
-- changelogEntry: 
-    - summary: | 
-        Previously, the OpenAPI converter would bring over `title` on every 
-        single property. This field is extraneous, so now we ignore it. 
+- changelogEntry:
+    - summary: |
+        Previously, the OpenAPI converter would bring over `title` on every
+        single property. This field is extraneous, so now we ignore it.
       type: fix
   irVersion: 53
   version: 0.42.10
 
-- changelogEntry: 
-    - summary: | 
-        Previously, the OpenAPI importer would ignore skip parsing arbitrary 
-        content types "*/*". Now it treats this content type as application/json. 
+- changelogEntry:
+    - summary: |
+        Previously, the OpenAPI importer would ignore skip parsing arbitrary
+        content types "*/*". Now it treats this content type as application/json.
 
         ```json openapi.json
         "responses": {
@@ -63,35 +75,35 @@
   irVersion: 53
   version: 0.42.9
 
-- changelogEntry: 
-    - summary: | 
+- changelogEntry:
+    - summary: |
         The API V2 configuration (in beta) now supports global header overrides.
-        This fixes a bug where those header overrides were getting dropped in 
+        This fixes a bug where those header overrides were getting dropped in
         certain cases.
 
         ```yml generators.yml
-        api: 
-          headers: 
+        api:
+          headers:
             X-API-VERSION: string
-          specs: 
+          specs:
             - openapi: /path/to/openapi
               overrides: /path/to/overrides
         ```
       type: fix
   irVersion: 53
   version: 0.42.8
 
-- changelogEntry: 
-    - summary: | 
-        The API V2 configuration (in beta) now supports global header 
-        overrides. To specify global headers that are not in your 
-        OpenAPI spec, simply add the following block in your `generators.yml`: 
+- changelogEntry:
+    - summary: |
+        The API V2 configuration (in beta) now supports global header
+        overrides. To specify global headers that are not in your
+        OpenAPI spec, simply add the following block in your `generators.yml`:
 
         ```yml generators.yml
-        api: 
-          headers: 
+        api:
+          headers:
             X-API-VERSION: string
-          specs: 
+          specs:
             - openapi: /path/to/openapi
               overrides: /path/to/overrides
         ```

packages/cli/docs-resolver/src/DocsDefinitionResolver.ts

@@ -406,7 +406,8 @@ export class DocsDefinitionResolver {
                 };
             }
             case "changelog": {
-                const idgen = NodeIdGenerator.init(parentSlug.get());
+                const slug = item.slug ?? kebabCase(item.title);
+                const idgen = NodeIdGenerator.init(parentSlug.get()).append(slug);
                 const node = new ChangelogNodeConverter(
                     this.markdownFilesToFullSlugs,
                     item.changelog,
@@ -419,13 +420,14 @@ export class DocsDefinitionResolver {
                     hidden: item.hidden,
                     slug: item.slug
                 });
+
                 return {
                     type: "changelogV3",
                     node: node ?? {
                         id: idgen.append("changelog").get(),
                         type: "changelog",
                         title: item.title,
-                        slug: parentSlug.append(item.slug ?? kebabCase(item.title)).get(),
+                        slug: parentSlug.append(slug).get(),
                         children: []
                     }
                 };