Skip to content

docs(api-v2): sync API reference from Frontdoor v2.10.0 - #833

Merged
lavanya-gunreddi merged 3 commits into
mainfrom
automation/frontdoor-openapi
Sep 2, 2026
Merged

docs(api-v2): sync API reference from Frontdoor v2.10.0#833
lavanya-gunreddi merged 3 commits into
mainfrom
automation/frontdoor-openapi

Conversation

@runpod-docs-sync

Copy link
Copy Markdown

Automated from runpod/rphttp2@v2.10.0.

api-reference-v2/openapi.json, the endpoint MDX files under api-reference-v2/, and the API v2 navigation groups in docs.json are generated together from Frontdoor's canonical spec/openapi.yaml. Do not edit them independently.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

@Promptless Don't remove or overwrite existing description fields in MDX files. If a description already exists on a page, keep it unchanged. For MDX files that are missing a description, add one that matches the tone and style of existing descriptions and accurately describes the page content. Keep all descriptions between 110 and 160 characters.

@promptless

promptless Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Got it — I'll audit the changed api-reference-v2/ MDX files in this PR: existing description fields will be left untouched, and I'll add a 110–160 character description to any page that's missing one, matching the tone of the existing ones. I'll follow up here with what changed.

@promptless

promptless Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Update: I looked into it. The automated Frontdoor sync in this PR stripped the curated description frontmatter from 44 endpoint pages (those descriptions still exist on main), and 2 newly added Serverless build endpoints never had one. Plan: restore the 44 descriptions verbatim from main and author 2 new ones matching the sibling Serverless pages' tone — all within 110–160 characters. Drafting the changes now.

…dpoint descriptions

The Frontdoor v2.10.0 sync dropped the curated description frontmatter
from 44 api-reference-v2 endpoint pages. Restore each verbatim from main
and add descriptions for the two new serverless build endpoints, keeping
every value within the 110-160 character meta-description range.
@promptless

promptless Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Done — the fix is now on this PR. Every description that already existed was left untouched. The 44 endpoint descriptions this sync had stripped are restored exactly as they were on main, and the two new Serverless build endpoints (get-a-serverless-endpoint-build, list-serverless-endpoint-builds) now have descriptions in the same style. All are within 110–160 characters. Nothing else changed — openapi.json, docs.json, and the page bodies are unchanged.

One thing worth flagging: api-reference-v2/ is regenerated from Frontdoor's canonical spec on every sync, and that generation step is what dropped these descriptions in the first place. This commit fixes the current PR, but the same descriptions will be stripped again on the next sync unless the generator is updated to preserve existing description frontmatter (or to source descriptions from the spec). We'd recommend addressing that in the upstream sync workflow (runpod/rphttp2) so it doesn't recur.

@lavanya-gunreddi
lavanya-gunreddi merged commit a036e0e into main Sep 2, 2026
1 check passed
@lavanya-gunreddi
lavanya-gunreddi deleted the automation/frontdoor-openapi branch September 2, 2026 22:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants