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: add x-tags #2355

Merged
merged 5 commits into from
Jul 26, 2023
Merged

feat: add x-tags #2355

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
869216e
feat: add x-tags
AlexVarchuk Jul 13, 2023
2e55017
chore: fix e2e tests and add new for x-tag
AlexVarchuk Jul 19, 2023
01c294f
chore: add x-tags to demo definition
AlexVarchuk Jul 19, 2023
10a64ca
Merge branch 'main' into feat/add-x-tags
AlexVarchuk Jul 19, 2023
a2ebb29
chore: update snapshots
AlexVarchuk Jul 19, 2023
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
3 changes: 2 additions & 1 deletion src/components/SideMenu/MenuItem.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ export class MenuItem extends React.Component<MenuItemProps> {
<OperationMenuItemContent {...this.props} item={item as OperationModel} />
) : (
<MenuItemLabel depth={item.depth} active={item.active} type={item.type} ref={this.ref}>
<MenuItemTitle title={item.sidebarLabel}>
{item.type === 'schema' && <OperationBadge type="schema">schema</OperationBadge>}
<MenuItemTitle width="calc(100% - 38px)" title={item.sidebarLabel}>
{item.sidebarLabel}
{this.props.children}
</MenuItemTitle>
Expand Down
24 changes: 14 additions & 10 deletions src/components/SideMenu/styled.elements.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,43 +26,47 @@ export const OperationBadge = styled.span.attrs((props: { type: string }) => ({
margin-top: 2px;

&.get {
background-color: ${props => props.theme.colors.http.get};
background-color: ${({ theme }) => theme.colors.http.get};
}

&.post {
background-color: ${props => props.theme.colors.http.post};
background-color: ${({ theme }) => theme.colors.http.post};
}

&.put {
background-color: ${props => props.theme.colors.http.put};
background-color: ${({ theme }) => theme.colors.http.put};
}

&.options {
background-color: ${props => props.theme.colors.http.options};
background-color: ${({ theme }) => theme.colors.http.options};
}

&.patch {
background-color: ${props => props.theme.colors.http.patch};
background-color: ${({ theme }) => theme.colors.http.patch};
}

&.delete {
background-color: ${props => props.theme.colors.http.delete};
background-color: ${({ theme }) => theme.colors.http.delete};
}

&.basic {
background-color: ${props => props.theme.colors.http.basic};
background-color: ${({ theme }) => theme.colors.http.basic};
}

&.link {
background-color: ${props => props.theme.colors.http.link};
background-color: ${({ theme }) => theme.colors.http.link};
}

&.head {
background-color: ${props => props.theme.colors.http.head};
background-color: ${({ theme }) => theme.colors.http.head};
}

&.hook {
background-color: ${props => props.theme.colors.primary.main};
background-color: ${({ theme }) => theme.colors.primary.main};
}

&.schema {
background-color: ${({ theme }) => theme.colors.http.basic};
}
`;

Expand Down
38 changes: 37 additions & 1 deletion src/services/MenuBuilder.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { OpenAPISpec, OpenAPIPaths } from '../types';
import type { OpenAPISpec, OpenAPIPaths, OpenAPITag, OpenAPISchema } from '../types';
import { isOperationName, JsonPointer, alphabeticallyByProp } from '../utils';
import { MarkdownRenderer } from './MarkdownRenderer';
import { GroupModel, OperationModel } from './models';
Expand Down Expand Up @@ -137,7 +137,14 @@ export class MenuBuilder {
continue;
}

const relatedSchemas = this.getTagRelatedSchema({
parser,
tag,
parent: item,
});

item.items = [
...relatedSchemas,
...MenuBuilder.addMarkdownItems(tag.description || '', item, item.depth + 1, options),
...this.getOperationsItems(parser, item, tag, item.depth + 1, options),
];
Expand Down Expand Up @@ -248,4 +255,33 @@ export class MenuBuilder {
}
return tags;
}

static getTagRelatedSchema({
parser,
tag,
parent,
}: {
parser: OpenAPIParser;
tag: TagInfo;
parent: GroupModel;
}): GroupModel[] {
return Object.entries(parser.spec.components?.schemas || {})
.map(([schemaName, schema]) => {
const schemaTags = schema['x-tags'];
if (!schemaTags?.includes(tag.name)) return null;

const item = new GroupModel(
'schema',
{
name: schemaName,
'x-displayName': `${(schema as OpenAPISchema).title || schemaName}`,
description: `<SchemaDefinition showWriteOnly={true} schemaRef="#/components/schemas/${schemaName}" />`,
} as OpenAPITag,
parent,
);
item.depth = parent.depth + 1;
return item;
})
.filter(Boolean) as GroupModel[];
}
}
2 changes: 1 addition & 1 deletion src/services/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ export interface TagGroup {
tags: string[];
}

export type MenuItemGroupType = 'group' | 'tag' | 'section';
export type MenuItemGroupType = 'group' | 'tag' | 'section' | 'schema';
export type MenuItemType = MenuItemGroupType | 'operation';

export interface IMenuItem {
Expand Down
Loading