Skip to content

chore(v1): update redoc to 2.5.0 #2054

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

Merged
tatomyr merged 4 commits into from
Apr 22, 2025
Merged

chore(v1): update redoc to 2.5.0 #2054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
440afc4
chore: update redoc to 2.5.0
roman-sainchuk Apr 15, 2025
2533306
fix e2e snapshots and smokes
tatomyr Apr 16, 2025
7787bc8
allow numbers in scopes
tatomyr Apr 16, 2025
47019e8
add changeset
tatomyr Apr 16, 2025
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
5 changes: 5 additions & 0 deletions .changeset/tricky-papayas-burn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@redocly/cli": patch
---

Updated Redoc to v2.5.0.
2 changes: 1 addition & 1 deletion .github/workflows/pr-title.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
env:
PR_TITLE: ${{ github.event.pull_request.title }}
run: |
if ! echo "$PR_TITLE" | grep -E "^(fix|feat|chore|docs)(\([a-z-]+\))?: (🔖 |🧪 )?[a-z].+[^.]$"; then
if ! echo "$PR_TITLE" | grep -E "^(fix|feat|chore|docs)(\([a-z0-9-]+\))?: (🔖 |🧪 )?[a-z].+[^.]$"; then
echo "❌ PR title '$PR_TITLE' does not match the required format"
echo "Required format: type(scope): subject"
echo "Examples:"
Expand Down
2 changes: 1 addition & 1 deletion __tests__/build-docs/simple-build-docs/snapshot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ exports[`E2E build-docs simple build-docs 1`] = `
Found undefined and using theme.openapi options
Prerendering docs

🎉 bundled successfully in: redoc-static.html (330 KiB) [⏱ <test>ms].
🎉 bundled successfully in: redoc-static.html (332 KiB) [⏱ <test>ms].


`;
2 changes: 1 addition & 1 deletion __tests__/commands.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,7 +667,7 @@ describe('E2E', () => {
(<any>expect(cleanupOutput(result))).toMatchSpecificSnapshot(join(testPath, 'snapshot.js'));

expect(fs.existsSync(join(testPath, 'nested/redoc-static.html'))).toEqual(true);
expect(fs.statSync(join(testPath, 'nested/redoc-static.html')).size).toEqual(36238);
expect(fs.statSync(join(testPath, 'nested/redoc-static.html')).size).toEqual(36309);
});
});

Expand Down
6 changes: 3 additions & 3 deletions __tests__/smoke/pre-built/redoc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
margin: 0;
}
</style>
<script src="https://cdn.redocly.com/redoc/v2.4.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.17">.hJuoxX{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
<script src="https://cdn.redocly.com/redoc/v2.5.0/bundles/redoc.standalone.js"></script><style data-styled="true" data-styled-version="6.1.17">.hJuoxX{width:calc(100% - 40%);padding:0 40px;}/*!sc*/
@media print,screen and (max-width: 75rem){.hJuoxX{width:100%;padding:40px 40px;}}/*!sc*/
data-styled.g4[id="sc-fWnslK"]{content:"hJuoxX,"}/*!sc*/
.bTqehu{padding:40px 0;}/*!sc*/
Expand Down Expand Up @@ -289,7 +289,7 @@

<body>

<div id="redoc"><div class="sc-ldfREC cJUmVI redoc-wrap"><div class="sc-dVElco kvyhOU menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-ikZCWJ hnCKSs"><svg class="sc-edfAab jutLom search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-kWJkYy erbREP search-input" value=""/></div><div class="sc-dZEakj plAcM scrollbar-container undefined"><ul role="menu" class="sc-kNNXoD jyJesI"><li tabindex="0" depth="2" data-item-id="operation/getMessage" role="menuitem" class="sc-bfkVnW GjPJT"><label class="sc-dSsMvJ icIHsb -depth2"><span type="get" class="sc-iwCIRy eMvmBu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fzltTY iqJPdR">Get a greeting message</span></label></li></ul><div class="sc-kHrqIz cEaUaF"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-irwjCN cfBNXY"><div class="sc-djWYAM jbbkDm"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
<div id="redoc"><div class="sc-ldfREC cJUmVI redoc-wrap"><div class="sc-dVElco kvyhOU menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-ikZCWJ hnCKSs"><svg class="sc-edfAab jutLom search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-kWJkYy erbREP search-input" value=""/></div><div class="sc-dZEakj plAcM scrollbar-container undefined"><ul role="menu" class="sc-kNNXoD jyJesI"><li tabindex="0" depth="2" data-item-id="operation/getMessage" role="menuitem" aria-label="Get a greeting message" aria-expanded="false" class="sc-bfkVnW GjPJT"><label class="sc-dSsMvJ icIHsb -depth2"><span type="get" class="sc-iwCIRy eMvmBu operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-fzltTY iqJPdR">Get a greeting message</span></label></li></ul><div class="sc-kHrqIz cEaUaF"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-irwjCN cfBNXY"><div class="sc-djWYAM jbbkDm"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
0 79.8637,78.60862 175.9427,174.68583 l 174.6892,174.6858 174.6892,
Expand All @@ -311,7 +311,7 @@
" class="sc-dTUlgT sc-fhPBcz sc-dNpohg gAHTYt hNgelr kfJzSr"><p>OK</p>
</div></button></div><div><button class="sc-koGwOT fJrWIH"><svg class="sc-dcKlJK ecvXEv" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg><strong class="sc-dHZbTr ljgvjV">400<!-- --> </strong><div html="&lt;p&gt;Bad request.&lt;/p&gt;
" class="sc-dTUlgT sc-fhPBcz sc-dNpohg gAHTYt hNgelr kfJzSr"><p>Bad request.</p>
</div></button></div></div></div><div class="sc-iQQCXo sc-gDpztx rcGrS ijAuiF"><div class="sc-dYwfDW bgkhSA"><button class="sc-lnzCgU brWdLq"><span type="get" class="sc-etVRix kZNoUr http-verb get">get</span><span class="sc-iuoeev hwDgZR">/hello</span><svg class="sc-dcKlJK hopFSn" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dRZyXS gTtGYM"><div class="sc-inRxyr iajdpk"><div html="" class="sc-dTUlgT sc-fhPBcz gAHTYt iCKFAv"></div><div tabindex="0" role="button"><div class="sc-lhcVAQ becpLA"><span>http://redocly-example.com</span>/hello</div></div></div></div></div><div><h3 class="sc-jJAtPt esvUOo"> <!-- -->Response samples<!-- --> </h3><div class="sc-brzPDJ ihptAH" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pq»1" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pq»0" aria-labelledby="tab«R9pq»0"><div><div class="sc-bmCFzp hMtTVz"><span class="sc-fPyrPm ktNiSp">Content type</span><div class="sc-bpuAaX dmqyho">application/json</div></div><div class="sc-kmqAS jPYqSz"><div class="sc-eZbeWy ihHZyU"><div class="sc-lpbaSe elUMPN"><button><div class="sc-fsjlER jYcDQz">Copy</div></button></div><div class="sc-dTUlgT gAHTYt sc-gDVcuj JZxXP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pq»1" aria-labelledby="tab«R9pq»1"></div></div></div></div></div></div></div><div class="sc-dPhEwk cCFEoS"></div></div></div>
</div></button></div></div></div><div class="sc-iQQCXo sc-gDpztx rcGrS ijAuiF"><div class="sc-dYwfDW bgkhSA"><button class="sc-lnzCgU brWdLq"><span type="get" class="sc-etVRix kZNoUr http-verb get">get</span><span class="sc-iuoeev hwDgZR">/hello</span><svg class="sc-dcKlJK hopFSn" style="margin-right:-25px" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></button><div aria-hidden="true" class="sc-dRZyXS gTtGYM"><div class="sc-inRxyr iajdpk"><div html="" class="sc-dTUlgT sc-fhPBcz gAHTYt iCKFAv"></div><div tabindex="0" role="button"><div class="sc-lhcVAQ becpLA"><span>http://redocly-example.com</span>/hello</div></div></div></div></div><div><h3 class="sc-jJAtPt esvUOo"> <!-- -->Response samples<!-- --> </h3><div class="sc-brzPDJ ihptAH" data-rttabs="true"><ul class="react-tabs__tab-list" role="tablist"><li class="tab-success react-tabs__tab--selected" role="tab" id="tab«R9pq»0" aria-selected="true" aria-disabled="false" aria-controls="panel«R9pq»0" tabindex="0" data-rttab="true">200</li><li class="tab-error" role="tab" id="tab«R9pq»1" aria-selected="false" aria-disabled="false" aria-controls="panel«R9pq»1" data-rttab="true">400</li></ul><div class="react-tabs__tab-panel react-tabs__tab-panel--selected" role="tabpanel" id="panel«R9pq»0" aria-labelledby="tab«R9pq»0"><div><div class="sc-bmCFzp hMtTVz"><span class="sc-fPyrPm ktNiSp">Content type</span><div class="sc-bpuAaX dmqyho">application/json</div></div><div class="sc-kmqAS jPYqSz"><div class="sc-eZbeWy ihHZyU"><div class="sc-lpbaSe elUMPN"><button><div class="sc-fsjlER jYcDQz">Copy</div></button></div><div tabindex="0" class="sc-dTUlgT gAHTYt sc-gDVcuj JZxXP"><div class="redoc-json"><code><button class="collapser" aria-label="collapse"></button><span class="token punctuation">{</span><span class="ellipsis"></span><ul class="obj collapsible"><li><div class="hoverable "><span class="property token string">"message"</span>: <span class="token string">&quot;string&quot;</span></div></li></ul><span class="token punctuation">}</span></code></div></div></div></div></div></div><div class="react-tabs__tab-panel" role="tabpanel" id="panel«R9pq»1" aria-labelledby="tab«R9pq»1"></div></div></div></div></div></div></div><div class="sc-dPhEwk cCFEoS"></div></div></div>
<script>
const __redoc_state = {"menu":{"activeItemIdx":-1},"spec":{"data":{"openapi":"3.1.0","servers":[{"url":"http://redocly-example.com"}],"info":{"title":"Sample API","version":"1.0.0"},"paths":{"/hello":{"get":{"operationId":"getMessage","security":[],"summary":"Get a greeting message","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/message-schema"}}}},"400":{"$ref":"#/components/responses/BadRequest"}}}}},"components":{"schemas":{"message-schema":{"type":"object","properties":{"message":{"type":"string"}}},"Error":{"type":"object","properties":{"type":{"type":"string","example":"object"},"title":{"type":"string","example":"Validation failed"}}}},"responses":{"BadRequest":{"description":"Bad request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"searchIndex":{"store":["operation/getMessage"],"index":{"version":"2.3.9","fields":["title","description"],"fieldVectors":[["title/0",[0,0.288,1,0.288]],["description/0",[2,0.288]]],"invertedIndex":[["greet",{"_index":0,"title":{"0":{}},"description":{}}],["hello",{"_index":2,"title":{},"description":{"0":{}}}],["messag",{"_index":1,"title":{"0":{}},"description":{}}]],"pipeline":[]}},"options":{}};

Expand Down
Loading
Loading