From 78b724a35a9e69fa30c6f30818e23f1073792697 Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Mon, 5 Dec 2016 13:50:06 +0000 Subject: [PATCH 1/2] Fix typo in filename --- ...chema-helper.serivce.spec.ts => schema-helper.service.spec.ts} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename lib/services/{schema-helper.serivce.spec.ts => schema-helper.service.spec.ts} (100%) diff --git a/lib/services/schema-helper.serivce.spec.ts b/lib/services/schema-helper.service.spec.ts similarity index 100% rename from lib/services/schema-helper.serivce.spec.ts rename to lib/services/schema-helper.service.spec.ts From d88fe7d5a096cddc6fcc9e1ca808a727aeaac730 Mon Sep 17 00:00:00 2001 From: Ben Firshman Date: Mon, 5 Dec 2016 16:25:14 +0000 Subject: [PATCH 2/2] Add display name for tags In go-swagger, the name of the tag determines the directory that generated files end up in. Also, we want the tag names to be consistent with operationIds. Unfortunately, these make bad names for menu items, so we want to have a way of specifying human-friendly names for the menu. --- docs/redoc-vendor-extensions.md | 7 +++++++ lib/components/MethodsList/methods-list.html | 2 +- lib/services/schema-helper.service.spec.ts | 21 +++++++++++++++----- lib/services/schema-helper.service.ts | 2 +- 4 files changed, 25 insertions(+), 7 deletions(-) diff --git a/docs/redoc-vendor-extensions.md b/docs/redoc-vendor-extensions.md index 6cda39083e..7328d1008b 100644 --- a/docs/redoc-vendor-extensions.md +++ b/docs/redoc-vendor-extensions.md @@ -54,6 +54,13 @@ Extends OpenAPI [Tag Object](http://swagger.io/specification/#tagObject) | :------------- | :------: | :---------- | | x-traitTag | boolean | In Swagger two operations can have multiply tags. This property distinguish between tags that are used to group operations (default) from tags that are used to mark operation with certain trait (`true` value) | +#### x-displayName + +| Field Name | Type | Description | +| :------------- | :------: | :---------- | +| x-displayName | string | Define the text that is used for this tag in the menu and in section headings | + + ###### Usage in Redoc Tags that have `x-traitTag` set to `true` are listed in side-menu but don't have any subitems (operations). Tag `description` is rendered as well. This is useful for handling out common things like Pagination, Rate-Limits, etc. diff --git a/lib/components/MethodsList/methods-list.html b/lib/components/MethodsList/methods-list.html index 225a1930c6..61caa17f09 100644 --- a/lib/components/MethodsList/methods-list.html +++ b/lib/components/MethodsList/methods-list.html @@ -1,7 +1,7 @@
-

{{tag.name}}

+

{{tag.name}}

{ let suitSchema = { tags: [ {name: 'tag1', description: 'info1', 'x-traitTag': true}, - {name: 'tag2', description: 'info2'} + {name: 'tag2', description: 'info2'}, + {name: 'tag4', description: 'info2', 'x-displayName': 'Tag Four'} ], paths: { test: { @@ -19,6 +20,10 @@ describe('Spec Helper', () => { tags: ['tag1', 'tag2'], summary: 'test get' }, + delete: { + tags: ['tag4'], + summary: 'test delete' + }, // no tags post: { summary: 'test post' @@ -41,19 +46,19 @@ describe('Spec Helper', () => { }); it('should return Array with correct number of items', () => { - //2 - defined tags, 1 - tag3 and 1 [other] tag for no-tags method - menuTree.length.should.be.equal(2 + 1 + 1); + //3 - defined tags, 1 - tag3 and 1 [other] tag for no-tags method + menuTree.length.should.be.equal(3 + 1 + 1); }); it('should append not defined tags to the end of list', () => { - let info = menuTree[2]; + let info = menuTree[3]; info.name.should.be.equal('tag3'); info.methods.length.should.be.equal(1); info.methods[0].summary.should.be.equal('test put'); }); it('should append methods without tags to [other] tag', () => { - let info = menuTree[3]; + let info = menuTree[4]; info.name.should.be.equal(''); info.methods.length.should.be.equal(1); info.methods[0].summary.should.be.equal('test post'); @@ -84,6 +89,12 @@ describe('Spec Helper', () => { } } }); + + it('should use x-displayName to set custom names', () => { + let info = menuTree[2]; + info.id.should.be.equal('tag/tag4'); + info.name.should.be.equal('Tag Four'); + }); }); describe('injectors', () => { diff --git a/lib/services/schema-helper.service.ts b/lib/services/schema-helper.service.ts index 642ac585aa..cfdb42e255 100644 --- a/lib/services/schema-helper.service.ts +++ b/lib/services/schema-helper.service.ts @@ -315,7 +315,7 @@ export class SchemaHelper { for (let tag of schema.tags || []) { let id = 'tag/' + slugify(tag.name); tag2MethodMapping[id] = { - name: tag.name, + name: tag['x-displayName'] || tag.name, id: id, description: tag.description, headless: tag.name === '',