Skip to content

Make apireference layout generic #1712

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
merged 3 commits into from
Jun 20, 2025
Merged

Make apireference layout generic #1712

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8877a67
attempt to generic api reference
cmilesb Jun 16, 2025
fbaecdb
Add defaults, dynamically generate back to docs link, and change RDI …
cmilesb Jun 18, 2025
2a5f248
Remove rdiapireference.html
cmilesb Jun 20, 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: 4 additions & 1 deletion content/operate/rc/api/api-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
Title: API Reference
Title: Redis Cloud API
linkTitle: API reference
layout: apireference
type: page
params:
sourcefile: ./openapi.json
---
4 changes: 2 additions & 2 deletions layouts/_default/apireference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>

<head>
<title>Redis Cloud API</title>
<title>{{ .Title }}</title>
{{ partial "scss.html" (dict "path" "scss/style.scss") }}
{{ partial "css.html" (dict "path" "css/index.css") }}
{{ $relref := printf "%s%s" .Site.BaseURL "operate/rc/api/" }}
Copy link
Collaborator

@paoloredis paoloredis Jun 17, 2025

Choose a reason for hiding this comment

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

We'll have to inject the baseurl dynamically as well

Copy link
Contributor Author

@cmilesb cmilesb Jun 18, 2025

Choose a reason for hiding this comment

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

I think I fixed that in fbaecdb, let me know what you think.

Copy link
Collaborator

@paoloredis paoloredis Jun 19, 2025

Choose a reason for hiding this comment

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

Looks good.

Expand Down Expand Up @@ -62,7 +62,7 @@
<body>
<div>
<redoc
spec-url='./openapi.json'
spec-url='{{ .Params.sourcefile }}'
scroll-y-offset='#apiReferenceHeader'
json-sample-expand-level=all
sort-operations-alphabetically="true"
Expand Down