Skip to content

Fix(WEB-9483): Index HTTP Method + Path (GET /<path>) for API Search #37784

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

Open
onceLearner wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Fix(WEB-9483): Index HTTP Method + Path (GET /<path>) for API Search #37784

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6e77ed3
feat(search): index API endpoint REST paths in content field
onceLearner Jun 25, 2026
52d0518
docs(search): comment API endpoint path/method capture
onceLearner Jun 26, 2026
636aaf1
chore(search): revert API path indexing to baseline
onceLearner Jun 26, 2026
b59b050
fix(search): dedupe v1/v2 API records by anchorized summary
onceLearner Jun 26, 2026
2dd211f
[empty] trigger build to test updated api
onceLearner Jun 26, 2026
72a7fdd
[test] tweak bits_chat overview wording to verify single-record sync …
onceLearner Jun 26, 2026
e484b19
Revert [test] bits_chat wording change
onceLearner Jun 26, 2026
8d8546d
Re-add API path/method indexing as a commented, inert toggle
onceLearner Jun 26, 2026
ac554c2
Enable API endpoint path/method indexing in content field
onceLearner Jun 26, 2026
d8d7abf
Trim stale/low-value comments on API path indexing
onceLearner Jun 26, 2026
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
8 changes: 7 additions & 1 deletion layouts/partials/algolia/api-page-index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
{{ $lang := .lang }}
{{ $api_version := .api_version }} {{/* "v1" or "v2" */}}
{{ $endpoint_data := .endpoint_data }}
{{ $endpoint_path := .endpoint_path }}
{{ $method := .method }}
{{ $api_v1_translate_actions := .api_v1_translate_actions }}
{{ $api_v2_translate_actions := .api_v2_translate_actions }}

Expand All @@ -20,13 +22,17 @@
{{ $action_data := index $translate_actions_datafile $operationId }}
{{ $section_header := $action_data.summary }}
{{ $section_content := $action_data.description }}

{{/* Append "METHOD /path" so the endpoint's REST path is searchable. Kept at the end to stay out of the embedding's truncated input. */}}
{{ $section_content = printf "%s\n\n%s %s" ($section_content | default "") (upper $method) $endpoint_path | strings.TrimSpace }}

{{ $endpoint_slug := $section_header | anchorize }}
{{ $full_url := print $permalink $endpoint_slug "/" }}
{{ $relpermalink = print $relpermalink $endpoint_slug "/" }}

{{/* When the same operationId+summary exists in both v1 and v2, both versions share one endpoint page with version tabs. Disambiguate the records by linking to the tab anchor. */}}
{{ $other_action := cond (eq $api_version "v1") (index $api_v2_translate_actions $operationId) (index $api_v1_translate_actions $operationId) }}
{{ if and (ne $other_action nil) (eq $other_action.summary $section_header) }}
{{ if and (ne $other_action nil) (eq ($other_action.summary | anchorize) ($section_header | anchorize)) }}
{{ $tab_anchor := (print $section_header "-" $api_version) | anchorize }}
{{ $full_url = print $full_url "#" $tab_anchor }}
{{ $relpermalink = print $relpermalink "#" $tab_anchor }}
Expand Down
20 changes: 12 additions & 8 deletions layouts/partials/algolia/api-pages-full-index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,10 @@

{{/* Get all v1 api actions for this page by matching title with spec data's tag property */}}
{{ range $endpoint_path, $endpoint_data := $api_v1_data.paths }}
{{ range $endpoint_data }}
{{ range $method, $action := $endpoint_data }}
{{ $tags := slice }}
{{ if isset . "tags" }}
{{ $tags = .tags }}
{{ if isset $action "tags" }}
{{ $tags = $action.tags }}
{{ end }}

{{ if in $tags $title }}
Expand All @@ -47,7 +47,9 @@
"title" $title
"lang" $lang
"api_version" "v1"
"endpoint_data" .
"endpoint_data" $action
"endpoint_path" $endpoint_path
"method" $method
"api_v1_translate_actions" $api_v1_translate_actions
"api_v2_translate_actions" $api_v2_translate_actions
)
Expand All @@ -60,10 +62,10 @@

{{/* Get all v2 api actions for this page by matching title with spec data's tag property */}}
{{ range $endpoint_path, $endpoint_data := $api_v2_data.paths }}
{{ range $endpoint_data }}
{{ range $method, $action := $endpoint_data }}
{{ $tags := slice }}
{{ if isset . "tags" }}
{{ $tags = .tags }}
{{ if isset $action "tags" }}
{{ $tags = $action.tags }}
{{ end }}

{{ if in $tags $title }}
Expand All @@ -75,7 +77,9 @@
"title" $title
"lang" $lang
"api_version" "v2"
"endpoint_data" .
"endpoint_data" $action
"endpoint_path" $endpoint_path
"method" $method
"api_v1_translate_actions" $api_v1_translate_actions
"api_v2_translate_actions" $api_v2_translate_actions
)
Expand Down
Loading