-
Notifications
You must be signed in to change notification settings - Fork 66.9k
Expand file tree
/
Copy pathcode-example-logic.ts
More file actions
149 lines (133 loc) · 3.97 KB
/
code-example-logic.ts
File metadata and controls
149 lines (133 loc) · 3.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
import { describe, expect, test } from 'vitest'
import {
shouldShowRequestContentType,
shouldShowResponseContentType,
generateExampleOptionTexts,
type CodeExample,
} from '@/rest/lib/code-example-utils'
describe('Request Content Type Logic', () => {
test('detects request content types differ correctly', () => {
const codeExamples: CodeExample[] = [
{
description: 'Example',
request: { contentType: 'text/plain' },
response: { contentType: 'text/html' },
},
{
description: 'Rendering markdown',
request: { contentType: 'text/x-markdown' },
response: { contentType: 'text/html' },
},
]
expect(shouldShowRequestContentType(codeExamples)).toBe(true)
expect(shouldShowResponseContentType(codeExamples)).toBe(false)
})
test('detects response content types differ correctly', () => {
const codeExamples: CodeExample[] = [
{
description: 'JSON example',
request: { contentType: 'application/json' },
response: { contentType: 'application/json' },
},
{
description: 'Another JSON example',
request: { contentType: 'application/json' },
response: { contentType: 'text/html' },
},
]
expect(shouldShowRequestContentType(codeExamples)).toBe(false)
expect(shouldShowResponseContentType(codeExamples)).toBe(true)
})
test('generates correct options for markdown/raw scenario', () => {
const markdownRawExamples: CodeExample[] = [
{
description: 'Example',
request: {
contentType: 'text/plain',
},
response: {
contentType: 'text/html',
},
},
{
description: 'Rendering markdown',
request: {
contentType: 'text/x-markdown',
},
response: {
contentType: 'text/html',
},
},
]
const options = generateExampleOptionTexts(markdownRawExamples)
expect(options).toEqual(['Example (text/plain)', 'Rendering markdown (text/x-markdown)'])
})
test('generates correct options when both request and response differ', () => {
const mixedExamples: CodeExample[] = [
{
description: 'JSON request',
request: {
contentType: 'application/json',
},
response: {
contentType: 'application/json',
},
},
{
description: 'Plain text request',
request: {
contentType: 'text/plain',
},
response: {
contentType: 'text/html',
},
},
]
const options = generateExampleOptionTexts(mixedExamples)
expect(options).toEqual([
'JSON request (application/json → application/json)',
'Plain text request (text/plain → text/html)',
])
})
test('does not show content types when they are all the same', () => {
const sameContentTypeExamples: CodeExample[] = [
{
description: 'First example',
request: {
contentType: 'application/json',
},
response: {
contentType: 'application/json',
},
},
{
description: 'Second example',
request: {
contentType: 'application/json',
},
response: {
contentType: 'application/json',
},
},
]
const options = generateExampleOptionTexts(sameContentTypeExamples)
expect(options).toEqual(['First example', 'Second example'])
})
test('handles single example correctly', () => {
const singleExample: CodeExample[] = [
{
description: 'Only example',
request: {
contentType: 'application/json',
},
response: {
contentType: 'application/json',
},
},
]
expect(shouldShowRequestContentType(singleExample)).toBe(false)
expect(shouldShowResponseContentType(singleExample)).toBe(false)
const options = generateExampleOptionTexts(singleExample)
expect(options).toEqual(['Only example'])
})
})