Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(elements): show tags description if exist #2594

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+24 −2
Open

feat(elements): show tags description if exist #2594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/elements/src/components/API/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ export function computeTagGroups<T extends GroupableNode>(serviceNode: ServiceNo
groupsByTagId[tagId].items.push(node);
} else {
const serviceTagIndex = lowerCaseServiceTags.findIndex(tn => tn === tagId);
const serviceTagName = serviceNode.tags[serviceTagIndex];
const serviceTag = serviceNode.tagsRaw?.[serviceTagIndex];
groupsByTagId[tagId] = {
title: serviceTagName || tagName,
title: serviceTag?.description || serviceTag?.name || tagName,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this makes sense as the description could be very long. In my case the description could even be multiple paragraphs which will never fit into the small space of the expandable title.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about this:

groupsByTagId[tagId] = {
  title: (serviceTag?.['x-show-description'] ? serviceTag.description : '') || serviceTag?.name || tagName,
}

or

groupsByTagId[tagId] = {
  title: (serviceTag?.description?.length <= 40 ? serviceTag.description : '') || serviceTag?.name || tagName,
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think that is good either. I'd still need a place where the full description is shown and not just part of it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume the idea here is to use the description-property of the tag when it's available? The fallback would be the name of the tag? I think we could use the x-traitTag vendor extension to distinguish between tags used for grouping in the table of contents or to tag operations.

You would then only consider x-traitTag=false for the description in the above case, if not, fallback to the name of the tag.

I think this is how Redocly is doing it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ended up using x-displayName to allow a different title in the navigation compared to the actual tag. It's the same one that is used by Redocly

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am proposing: #2603

items: [node],
};
}
Expand Down
20 changes: 20 additions & 0 deletions packages/elements/src/utils/oas/__tests__/oas.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,16 @@ describe('computeOasNodes', () => {
infoExtensions: {},
},
tags: ['operation-tag', 'model-tag'],
tagsRaw: [
{
id: '68c460dd9e97a',
name: 'operation-tag',
},
{
id: 'feec8b579ae6b',
name: 'model-tag',
},
],
children: [
{
type: 'http_operation',
Expand Down Expand Up @@ -171,6 +181,16 @@ describe('computeOasNodes', () => {
version: '1.0.0',
},
tags: ['operation-tag', 'model-tag'],
tagsRaw: [
{
id: '68c460dd9e97a',
name: 'operation-tag',
},
{
id: 'feec8b579ae6b',
name: 'model-tag',
},
],
children: [
{
type: 'http_operation',
Expand Down
1 change: 1 addition & 0 deletions packages/elements/src/utils/oas/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ function computeServiceNode(
name: serviceDocument.name,
data: serviceDocument,
tags: serviceDocument.tags?.map(tag => tag.name) || [],
tagsRaw: serviceDocument.tags,
children: computeChildNodes(document, document, map, transformOperation),
};

Expand Down
1 change: 1 addition & 0 deletions packages/elements/src/utils/oas/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ type Node<T, D> = {
name: string;
data: D;
tags: string[];
tagsRaw?: { name?: string; description?: string }[];
};

export type ServiceNode = Node<NodeType.HttpService, IHttpService> & { children: ServiceChildNode[] };
Expand Down