Skip to content

api: include alternate link for swagger / OpenAPI spec #23944

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
thaJeztah merged 1 commit into from
Jan 8, 2026
Merged

api: include alternate link for swagger / OpenAPI spec #23944

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions layouts/_default/api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
<!DOCTYPE html>
<html lang="en">

<head>
{{ $specURL := urls.Parse (printf "/%s%s.yaml" .File.Dir .File.ContentBaseName) }}
<title>{{ .Title }}</title>
<!-- needed for adaptive design -->
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="{{ .Description }}" />
<meta charset="utf-8" />
<!-- favicon -->
<link rel="shortcut icon" href="/assets/images/favicon.svg" type="image/svg">
<!--
Provide a link to the swagger / OpenAPI spec itself. We're currently using
Swagger (OpenAPI v2) for some, so use a more generic "application/yaml" type.

Once all our specs are updated to OpenAPI v3, we can change this to "application/vnd.oai.openapi"
-->
<link rel="alternate" href="{{ $specURL.String | absURL }}" type="application/yaml" title="{{ .Title }} (Swagger/OpenAPI)" />
<style>
body {
margin: 0;
Expand Down Expand Up @@ -49,7 +56,12 @@
</head>

<body>
{{ $specURL := urls.Parse (printf "/%s%s.yaml" .File.Dir .File.ContentBaseName) }}
<noscript>
<p>
This page is rendered with JavaScript.<br>
<a target="_blank" href="{{ $specURL.String | absURL }}" rel="noreferrer">Download {{ .Title }} Swagger/OpenAPI specification</a>
</p>
</noscript>
{{ if or (strings.HasPrefix .RelPermalink "/reference/api/hub/") (strings.HasPrefix .RelPermalink "/reference/api/registry/") }}
<redoc spec-url="{{ $specURL.String }}" suppress-warnings="true" lazy-rendering></redoc>
{{ else }}
Expand Down