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: allow to use x-tagGroups extension to define tree structure #2603

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
+1,241 −137
Open

feat: allow to use x-tagGroups extension to define tree structure #2603

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c27de5b
eat: allow to use `x-tagGroups` extension to define tree structure
weyert Jun 24, 2024
d168a9b
test: resolve the broken unit tests
weyert Jun 24, 2024
9367931
Merge branch 'main' into add-taggroups-support
weyert Jun 24, 2024
1d7073a
build: resolve build issues in the `elements`-package
weyert Jun 24, 2024
5cd4238
chore: Merge branch 'add-taggroups-support' of github.com:weyert/elem…
weyert Jun 24, 2024
8b8c428
style: resolve linting issues
weyert Jun 24, 2024
0e329b2
Merge branch 'main' into add-taggroups-support
weyert Jul 9, 2024
5392033
Merge branch 'main' into add-taggroups-support
weyert Jul 19, 2024
48454fa
Merge branch 'main' into add-taggroups-support
weyert Jul 25, 2024
f85120b
Merge branch 'main' into add-taggroups-support
ben-smartbear Aug 14, 2024
63c5d7d
Merge branch 'main' into add-taggroups-support
weyert Aug 15, 2024
b26c550
fix: resolve the build issues
weyert Aug 15, 2024
0af48ff
Merge branch 'main' into add-taggroups-support
weyert Aug 15, 2024
1520252
style: resolve linting issues
weyert Aug 15, 2024
fc7b9ac
chore: Merge branch 'add-taggroups-support' of github.com:weyert/elem…
weyert Aug 15, 2024
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
268 changes: 268 additions & 0 deletions packages/elements/src/__fixtures__/api-descriptions/simpleApiWithTagGroups.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,268 @@
export const simpleApiWithTagGroups = {
swagger: '2.0',
info: {
title: 'To-dos',
description: 'Great API, but has internal operations.',
version: '1.0',
contact: {
name: 'Stoplight',
url: 'https://stoplight.io',
},
license: {
name: 'MIT',
},
},
host: 'todos.stoplight.io',
schemes: ['https', 'http'],
consumes: ['application/json'],
produces: ['application/json'],
securityDefinitions: {
apikey: {
name: 'apikey',
type: 'apiKey',
in: 'query',
description: "Use `?apikey=123` to authenticate requests. It's super secure.",
},
},
tags: [
{
name: 'Todos',
'x-displayName': 'To-dos',
},
{
name: 'Retrieval',
'x-displayName': 'Retrieve To-do Items',
},
{
name: 'Management',
'x-displayName': 'Add/remove To-do Items',
},
],
'x-tagGroups': [
{
name: 'Todos',
tags: ['Retrieval', 'Management'],
},
],
paths: {
'/todos/{todoId}': {
parameters: [
{
name: 'todoId',
in: 'path',
required: true,
type: 'string',
},
],
get: {
operationId: 'GET_todo',
summary: 'Get Todo',
tags: ['Retrieval'],
'x-internal': true,
responses: {
'200': {
description: '',
schema: {
$ref: './models/todo-full.v1.json',
},
examples: {
'application/json': {
id: 1,
name: 'get food',
completed: false,
completed_at: '1955-04-23T13:22:52.685Z',
created_at: '1994-11-05T03:26:51.471Z',
updated_at: '1989-07-29T11:30:06.701Z',
},
},
},
'404': {
$ref: '../common/openapi.v1.yaml#/responses/404',
},
'500': {
$ref: '../common/openapi.v1.yaml#/responses/500',
},
},
},
put: {
operationId: 'PUT_todos',
summary: 'Update Todo',
tags: ['Management'],
parameters: [
{
name: 'body',
in: 'body',
schema: {
$ref: './models/todo-partial.v1.json',
example: {
name: "my todo's new name",
completed: false,
},
},
},
],
responses: {
'200': {
description: '',
schema: {
$ref: './models/todo-full.v1.json',
},
examples: {
'application/json': {
id: 9000,
name: "It's Over 9000!!!",
completed: true,
completed_at: null,
created_at: '2014-08-28T14:14:28.494Z',
updated_at: '2015-08-28T14:14:28.494Z',
},
},
},
'401': {
$ref: '../common/openapi.v1.yaml#/responses/401',
},
'404': {
$ref: '../common/openapi.v1.yaml#/responses/404',
},
'500': {
$ref: '../common/openapi.v1.yaml#/responses/500',
},
},
security: [
{
apikey: [],
},
],
},
delete: {
operationId: 'DELETE_todo',
summary: 'Delete Todo',
tags: ['Todos'],
responses: {
'204': {
description: '',
},
'401': {
$ref: '../common/openapi.v1.yaml#/responses/401',
},
'404': {
$ref: '../common/openapi.v1.yaml#/responses/404',
},
'500': {
$ref: '../common/openapi.v1.yaml#/responses/500',
},
},
security: [
{
apikey: [],
},
],
},
},
'/todos': {
post: {
operationId: 'POST_todos',
summary: 'Create Todo',
tags: ['Todos'],
parameters: [
{
name: 'body',
in: 'body',
schema: {
$ref: './models/todo-partial.v1.json',
example: {
name: "my todo's name",
completed: false,
},
},
},
],
responses: {
'201': {
description: '',
schema: {
$ref: './models/todo-full.v1.json',
},
examples: {
'application/json': {
id: 9000,
name: "It's Over 9000!!!",
completed: null,
completed_at: null,
created_at: '2014-08-28T14:14:28.494Z',
updated_at: '2014-08-28T14:14:28.494Z',
},
},
},
'401': {
$ref: '../common/openapi.v1.yaml#/responses/401',
},
'500': {
$ref: '../common/openapi.v1.yaml#/responses/500',
},
},
security: [
{
apikey: [],
},
],
description: 'This creates a Todo object.\n\nTesting `inline code`.',
},
get: {
operationId: 'GET_todos',
summary: 'List Todos',
tags: ['Todos'],
parameters: [
{
$ref: '../common/openapi.v1.yaml#/parameters/limit',
},
{
$ref: '../common/openapi.v1.yaml#/parameters/skip',
},
],
responses: {
'200': {
description: 'wefwefwef',
schema: {
type: 'array',
items: {
$ref: './models/todo-full.v1.json',
},
},
examples: {
'application/json': [
{
id: 1,
name: 'design the thingz',
completed: true,
},
{
id: 2,
name: 'mock the thingz',
completed: true,
},
{
id: 3,
name: 'code the thingz',
completed: false,
},
],
},
},
'500': {
$ref: '../common/openapi.v1.yaml#/responses/500',
},
},
description: 'This returns a list of todos.',
},
},
},
definitions: {
InternalSchema: {
title: 'Internal Schema',
description: 'Fun Internal Schema',
schema: { type: 'object' },
'x-internal': true,
},
},
};
3 changes: 2 additions & 1 deletion packages/elements/src/components/API/APIWithResponsiveSidebarLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ import * as React from 'react';
import { Redirect, useLocation } from 'react-router-dom';

import { ServiceNode } from '../../utils/oas/types';
import { computeAPITree, findFirstNodeSlug, isInternal } from './utils';
import { computeAPITree, findFirstNodeSlug } from './computeAPITree';
import { isInternal } from './utils';

type SidebarLayoutProps = {
serviceNode: ServiceNode;
Expand Down
3 changes: 2 additions & 1 deletion packages/elements/src/components/API/APIWithSidebarLayout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ import * as React from 'react';
import { Link, Redirect, useLocation } from 'react-router-dom';

import { ServiceNode } from '../../utils/oas/types';
import { computeAPITree, findFirstNodeSlug, isInternal } from './utils';
import { computeAPITree, findFirstNodeSlug } from './computeAPITree';
import { isInternal } from './utils';

type SidebarLayoutProps = {
serviceNode: ServiceNode;
Expand Down
Loading