Skip to content

fix: index static pages in api section #36924

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

Draft
onceLearner wants to merge 1 commit into
base: master
Choose a base branch
from
+22 −3
Draft

fix: index static pages in api section #36924

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
25 changes: 22 additions & 3 deletions layouts/_default/list.search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,30 @@
{{ $.Scratch.Add "algoliaindex" slice }}
{{ $section := $.Site.GetPage "section" .Section }}
{{ $hugo_context := . }}
{{ $apiPagesWithoutTypeAPI := slice "api/latest/" "api/latest/rate-limits/" "api/latest/scopes/" }}

{{ range (where (where (where .Site.AllPages "Kind" "!=" "home") "Type" "!=" "api") ".RelPermalink" "not in" $apiPagesWithoutTypeAPI) }}
{{- /*
Static API pages live under /api/ and carry `type: api`, but they have real markdown
bodies that should be indexed alongside other documentation. Paths are listed without
a language prefix; we strip the lang segment before comparing so all 5 languages match.
Auto-generated API tag/endpoint pages keep being indexed by api-pages-full-index.json.
*/ -}}
{{ $apiStaticPages := slice
"/api/latest/"
"/api/latest/using-the-api/"
"/api/latest/rate-limits/"
"/api/latest/scopes/" }}

{{ range (where .Site.AllPages "Kind" "!=" "home") }}
{{ $page := . }}
{{ if and ($page.IsDescendant $section) (ne $page.Params.type "partners") (ne $page.Params.private true) (not (in $page.RelPermalink "/faq")) (not $page.Draft) (not (isset .Params "external_redirect")) }}

{{- /* Strip /<lang>/ so non-English pages match the allow-list entries. */ -}}
{{ $comparePath := $page.RelPermalink }}
{{ if ne $page.Language.Lang "en" }}
{{ $comparePath = strings.TrimPrefix (printf "/%s" $page.Language.Lang) $comparePath }}
{{ end }}
{{ $isApiStatic := in $apiStaticPages $comparePath }}

{{ if and (or (ne $page.Type "api") $isApiStatic) ($page.IsDescendant $section) (ne $page.Params.type "partners") (ne $page.Params.private true) (not (in $page.RelPermalink "/faq")) (not $page.Draft) (not (isset .Params "external_redirect")) }}
{{- /* Generate unique ID for each page. Use file path when available, fallback to RelPermalink for pages without files (e.g. virtual pages). This avoids duplicate IDs while preserving existing IDs for 300k+ items. */ -}}
{{ $rel_path := "" }}
{{ with $page.File }}
Expand Down
Loading