feat: removed descriptions and added info.title as group names for x-…

…tagGroup in Join command (#1394) * chore: removed description for x-tagGroups for Join command * chore: updated snapshots * feat: replaced file names with `info.title` as group names in x-tagGroups for the `join` command * fix: changeset fix from patch to minor update --------- Co-authored-by: Mateusz Lis <[email protected]>
Redocly · Feb 2, 2024 · 8bff6a8 · 8bff6a8 · github-actions · Feb 2, 2024
1 parent 7ce9013
commit 8bff6a8
Show file tree

Hide file tree

Showing 39 changed files with 111 additions and 115 deletions.
diff --git a/.changeset/grumpy-toys-reply.md b/.changeset/grumpy-toys-reply.md
@@ -0,0 +1,6 @@
+---
+"@redocly/cli": minor
+---
+
+- Removed descriptions adding for x-tagGroups for the `join` command. Descriptions in x-tagGroups are not supported and cause errors on linting.
+- Updated `info.title` to be used as a name in x-tagGroups instead of a file name for the `join` command, so you can now join files with the same names.
diff --git a/__tests__/join/decorate/bar.yaml b/__tests__/join/decorate/bar.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Bar Example API
   description: This is an example API.
   version: 1.0.0
 servers:

diff --git a/__tests__/join/decorate/foo.yaml b/__tests__/join/decorate/foo.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Foo Example API
   description: This is an example API.
   version: 1.0.0
 servers:

diff --git a/__tests__/join/decorate/snapshot.js b/__tests__/join/decorate/snapshot.js
@@ -4,7 +4,7 @@ exports[`E2E join with options test with option: { name: 'decorate', value: true
 
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Foo Example API
   description: This is an example API.
   version: 1.0.0
 servers:
@@ -46,7 +46,7 @@ paths:
         - bar_other
 components: {}
 x-tagGroups:
-  - name: bar
+  - name: Bar Example API
     tags:
       - bar_other
 

diff --git a/__tests__/join/ignore-decorators/bar.yaml b/__tests__/join/ignore-decorators/bar.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Bar Example API
   description: This is an example API.
   version: 1.0.0
 servers:

diff --git a/__tests__/join/ignore-decorators/foo.yaml b/__tests__/join/ignore-decorators/foo.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Foo Example API
   description: This is an example API.
   version: 1.0.0
 servers:

diff --git a/__tests__/join/ignore-decorators/snapshot.js b/__tests__/join/ignore-decorators/snapshot.js
@@ -4,7 +4,7 @@ exports[`E2E join without options test: ignore-decorators 1`] = `
 
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Foo Example API
   description: This is an example API.
   version: 1.0.0
 servers:
@@ -58,10 +58,10 @@ paths:
         - bar_other
 components: {}
 x-tagGroups:
-  - name: foo
+  - name: Foo Example API
     tags:
       - foo_other
-  - name: bar
+  - name: Bar Example API
     tags:
       - bar_other
 

diff --git a/__tests__/join/json-and-yaml-input/bar.yaml b/__tests__/join/json-and-yaml-input/bar.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Bar Example API
   description: This is an example API.
   version: 1.0.0
 servers:

diff --git a/__tests__/join/json-and-yaml-input/foo.json b/__tests__/join/json-and-yaml-input/foo.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.0",
   "info": {
-    "title": "Example API",
+    "title": "Foo Example API",
     "description": "This is an example API.",
     "version": "1.0.0"
   },

diff --git a/__tests__/join/json-and-yaml-input/json-output.snapshot.js b/__tests__/join/json-and-yaml-input/json-output.snapshot.js
@@ -10,7 +10,7 @@ exports[`E2E join files with different extensions test with option: {
 {
   "openapi": "3.0.0",
   "info": {
-    "title": "Example API",
+    "title": "Foo Example API",
     "description": "This is an example API.",
     "version": "<version>"
   },
@@ -98,13 +98,13 @@ exports[`E2E join files with different extensions test with option: {
   "components": {},
   "x-tagGroups": [
     {
-      "name": "foo",
+      "name": "Foo Example API",
       "tags": [
         "foo_other"
       ]
     },
     {
-      "name": "bar",
+      "name": "Bar Example API",
       "tags": [
         "bar_other"
       ]

diff --git a/__tests__/join/json-and-yaml-input/yaml-output.snapshot.js b/__tests__/join/json-and-yaml-input/yaml-output.snapshot.js
@@ -9,7 +9,7 @@ exports[`E2E join files with different extensions test with option: {
 
 openapi: 3.0.0
 info:
-  title: Example API
+  title: Bar Example API
   description: This is an example API.
   version: 1.0.0
 servers:
@@ -63,10 +63,10 @@ paths:
         - foo_other
 components: {}
 x-tagGroups:
-  - name: bar
+  - name: Bar Example API
     tags:
       - bar_other
-  - name: foo
+  - name: Foo Example API
     tags:
       - foo_other
 

diff --git a/__tests__/join/multi-references-to-one-file/snapshot.js b/__tests__/join/multi-references-to-one-file/snapshot.js
@@ -76,12 +76,11 @@ components:
         subFoo:
           $ref: '#/components/schemas/FooObject'
 x-tagGroups:
-  - name: foo
+  - name: Sample API
     tags:
       - GetSingleFoo
       - Foo
       - foo_other
-    description: My sample api
   - name: bar
     tags:
       - CreateBar

diff --git a/__tests__/join/multiple-tags-in-same-files/bar.yaml b/__tests__/join/multiple-tags-in-same-files/bar.yaml
@@ -6,7 +6,7 @@ tags:
     description: Wild description
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Bar Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/multiple-tags-in-same-files/foo.yaml b/__tests__/join/multiple-tags-in-same-files/foo.yaml
@@ -4,7 +4,7 @@ tags:
     description: Store tags
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Foo Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/multiple-tags-in-same-files/snapshot.js b/__tests__/join/multiple-tags-in-same-files/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E join without options test: multiple-tags-in-same-files 1`] = `
 openapi: 3.0.0
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Foo Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT
@@ -71,16 +71,14 @@ paths:
           description: example description
 components: {}
 x-tagGroups:
-  - name: foo
+  - name: Foo Example OpenAPI 3 definition.
     tags:
       - Store
       - foo_other
-    description: Information about API
-  - name: bar
+  - name: Bar Example OpenAPI 3 definition.
     tags:
       - Pets
       - Dog
-    description: Information about API
 
 openapi.yaml: join processed in <test>ms
 

diff --git a/__tests__/join/prefix-components-with-info-prop/bar.yaml b/__tests__/join/prefix-components-with-info-prop/bar.yaml
@@ -4,7 +4,7 @@ tags:
     description: Bar Discription
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Bar Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/prefix-components-with-info-prop/foo.yaml b/__tests__/join/prefix-components-with-info-prop/foo.yaml
@@ -4,7 +4,7 @@ tags:
     description: Foo Discription
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition foo.
+  title: Foo Example OpenAPI 3 definition foo.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/prefix-components-with-info-prop/snapshot.js b/__tests__/join/prefix-components-with-info-prop/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E join with options test with option: { name: 'prefix-components-with
 openapi: 3.0.0
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition foo.
+  title: Foo Example OpenAPI 3 definition foo.
   description: Information about API
   license:
     name: MIT
@@ -52,23 +52,21 @@ paths:
         - bar_other
 components:
   schemas:
-    Example OpenAPI 3 definition foo._some-property:
+    Foo Example OpenAPI 3 definition foo._some-property:
       description: foo description
       type: string
-    Example OpenAPI 3 definition._some-property:
+    Bar Example OpenAPI 3 definition._some-property:
       description: bar description
       type: string
 x-tagGroups:
-  - name: foo
+  - name: Foo Example OpenAPI 3 definition foo.
     tags:
       - Foo
       - foo_other
-    description: Information about API
-  - name: bar
+  - name: Bar Example OpenAPI 3 definition.
     tags:
       - Bar
       - bar_other
-    description: Information about API
 
 openapi.yaml: join processed in <test>ms
 

diff --git a/__tests__/join/prefix-tags-with-filename/bar.yaml b/__tests__/join/prefix-tags-with-filename/bar.yaml
@@ -4,7 +4,7 @@ tags:
     description: Pet Discription
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Bar Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/prefix-tags-with-filename/foo.yaml b/__tests__/join/prefix-tags-with-filename/foo.yaml
@@ -4,7 +4,7 @@ tags:
     description: Pet Discription
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Foo Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/prefix-tags-with-filename/snapshot.js b/__tests__/join/prefix-tags-with-filename/snapshot.js
@@ -5,7 +5,7 @@ exports[`E2E join with options test with option: { name: 'prefix-tags-with-filen
 openapi: 3.0.0
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Foo Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT
@@ -52,16 +52,14 @@ paths:
         - bar_other
 components: {}
 x-tagGroups:
-  - name: foo
+  - name: Foo Example OpenAPI 3 definition.
     tags:
       - foo_Pet
       - foo_other
-    description: Information about API
-  - name: bar
+  - name: Bar Example OpenAPI 3 definition.
     tags:
       - bar_Pet
       - bar_other
-    description: Information about API
 
 openapi.yaml: join processed in <test>ms
 

diff --git a/__tests__/join/prefix-tags-with-info-prop/bar.yaml b/__tests__/join/prefix-tags-with-info-prop/bar.yaml
@@ -4,7 +4,7 @@ tags:
     description: Pet Discription
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Bar Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/prefix-tags-with-info-prop/foo.yaml b/__tests__/join/prefix-tags-with-info-prop/foo.yaml
@@ -4,7 +4,7 @@ tags:
     description: Pet Discription
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition with foo title.
+  title: Foo Example OpenAPI 3 definition with foo title.
   description: Information about API
   license:
     name: MIT

diff --git a/__tests__/join/prefix-tags-with-info-prop/snapshot.js b/__tests__/join/prefix-tags-with-info-prop/snapshot.js
@@ -5,23 +5,23 @@ exports[`E2E join with options test with option: { name: 'prefix-tags-with-info-
 openapi: 3.0.0
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition with foo title.
+  title: Foo Example OpenAPI 3 definition with foo title.
   description: Information about API
   license:
     name: MIT
     url: https://opensource.org/licenses/MIT
 servers:
   - url: https://redocly.com/v1
 tags:
-  - name: Example OpenAPI 3 definition with foo title._Pet
+  - name: Foo Example OpenAPI 3 definition with foo title._Pet
     description: Pet Discription
     x-displayName: Pet
-  - name: Example OpenAPI 3 definition with foo title._other
+  - name: Foo Example OpenAPI 3 definition with foo title._other
     x-displayName: other
-  - name: Example OpenAPI 3 definition._Pet
+  - name: Bar Example OpenAPI 3 definition._Pet
     description: Pet Discription
     x-displayName: Pet
-  - name: Example OpenAPI 3 definition._other
+  - name: Bar Example OpenAPI 3 definition._other
     x-displayName: other
 paths:
   /pets:
@@ -40,7 +40,7 @@ paths:
         '200':
           description: example description
       tags:
-        - Example OpenAPI 3 definition with foo title._other
+        - Foo Example OpenAPI 3 definition with foo title._other
   /pets/{petId}:
     post:
       summary: summary example
@@ -49,19 +49,17 @@ paths:
         '201':
           description: example description
       tags:
-        - Example OpenAPI 3 definition._other
+        - Bar Example OpenAPI 3 definition._other
 components: {}
 x-tagGroups:
-  - name: foo
+  - name: Foo Example OpenAPI 3 definition with foo title.
     tags:
-      - Example OpenAPI 3 definition with foo title._Pet
-      - Example OpenAPI 3 definition with foo title._other
-    description: Information about API
-  - name: bar
+      - Foo Example OpenAPI 3 definition with foo title._Pet
+      - Foo Example OpenAPI 3 definition with foo title._other
+  - name: Bar Example OpenAPI 3 definition.
     tags:
-      - Example OpenAPI 3 definition._Pet
-      - Example OpenAPI 3 definition._other
-    description: Information about API
+      - Bar Example OpenAPI 3 definition._Pet
+      - Bar Example OpenAPI 3 definition._other
 
 openapi.yaml: join processed in <test>ms
 

diff --git a/__tests__/join/reference-in-description/bar.yaml b/__tests__/join/reference-in-description/bar.yaml
@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   version: 1.0.0
-  title: Example OpenAPI 3 definition.
+  title: Bar Example OpenAPI 3 definition.
   description: Information about API
   license:
     name: MIT
St.^❔	Category	Percentage	Covered / Total
🟡	Statements	76.08%	4301/5653
🟡	Branches	65.73%	2233/3397
🟡	Functions	68.71%	694/1010
🟡	Lines	76.29%	4044/5301