STF-1834: Link to OpenAPI specs from developer docs

[oschwald]

Developers can now find the public OpenAPI specs from the developer docs. Add links on 11 overview, API, download, and community pages, plus a repository link in the general navigation. Each individual spec reference pairs its GitHub view with a raw file link for API tools and code generators.

Closes STF-1834.

Validation: Hugo build, Markdown formatting, internal-link and raw-HTML configuration checks, and spelling checks for the changed pages passed. Confirmed the links render in HTML and Markdown. All eleven GitHub and raw YAML destinations return HTTP 200 without authentication, and the raw files contain YAML.

The full lint run encountered unrelated spelling errors in the local, untracked mm_website checkout. Spelling checks scoped to the changed pages passed.

Summary by CodeRabbit

• Documentation
  • Added links to OpenAPI specifications across GeoIP, GeoLite, minFraud, and related API documentation, including details on endpoints, requests, responses, and webhooks.
  • Linked the specifications as resources for community tool development and noted their compatibility with API tools and code generators.
  • Added an “OpenAPI Specs” link to the General menu.

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 15fbd445-4ad1-47bf-b725-a92aa3fe61a0

📥 Commits

Reviewing files that changed from the base of the PR and between 303b194 and b693cca.

📒 Files selected for processing (18)

• content/contribute.md
• content/geoip/docs/web-services.md
• content/geoip/docs/web-services/requests.md
• content/geoip/docs/web-services/responses.md
• content/geoip/geoip-exchange.md
• content/geoip/geolocate-an-ip/web-services.md
• content/geoip/privacy-exclusions-api.md
• content/geoip/track-location-name-updates.md
• content/geoip/updating-databases.md
• content/license-key-validation-api.md
• content/minfraud/alerts.md
• content/minfraud/api-documentation.md
• content/minfraud/api-documentation/requests.md
• content/minfraud/api-documentation/responses.md
• content/minfraud/evaluate-a-transaction.md
• content/minfraud/report-a-transaction.md
• content/minfraud/working-with-transaction-dispositions.md
• hugo.toml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

---

📝 Walkthrough

Walkthrough

The site menu and contribution guide now link to MaxMind OpenAPI resources. GeoIP, minFraud, and license key validation documentation links to relevant specifications and describes their coverage or use.

Changes

OpenAPI documentation links

Layer / File(s)	Summary
Site discovery and specification overviews hugo.toml, content/contribute.md, content/geoip/docs/web-services.md, content/minfraud/api-documentation.md	The General menu and contribution guide link to OpenAPI resources. GeoIP and minFraud overview pages describe their specifications and their use with API tools and code generators.
GeoIP specification references content/geoip/docs/web-services/*, content/geoip/geoip-exchange.md, content/geoip/geolocate-an-ip/web-services.md, content/geoip/privacy-exclusions-api.md, content/geoip/track-location-name-updates.md, content/geoip/updating-databases.md	GeoIP documentation links to relevant specifications for service requests, responses, downloads, and Privacy Exclusions.
minFraud and license API references content/minfraud/*, content/minfraud/api-documentation/*, content/license-key-validation-api.md	minFraud documentation links to its specification for web services, request and response details, transaction reporting, dispositions, and alerts. License key validation documentation links to its specification.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: horgh

Merge Risk: ⚪ Minimal · up to b693c

The documentation links lead to the specifications for the described APIs, and existing minFraud response guidance remains available. No material merge risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to b693c

The change affects 2 systems.

Changed systems: content, hugo.toml

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

• observed — content (service) was modified; 17 changed files map to changed impact.
• observed — hugo.toml (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

• observed — Modified behavior in content/contribute.md: Added a link to the OpenAPI specifications for MaxMind web services.
• observed — Modified behavior in content/geoip/docs/web-services.md: Added a section linking to the GeoIP and GeoLite OpenAPI specification and describing its use with API tools and code generators.
• observed — Modified behavior in content/geoip/docs/web-services/requests.md: Added a reference to the GeoIP and GeoLite OpenAPI specification and described the topics it covers.
• observed — Modified behavior in content/geoip/docs/web-services/responses.md: Adds a link to the bundled GeoIP and GeoLite OpenAPI specification, identifying it as the source for response schemas and error responses.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding links to OpenAPI specifications from developer documentation.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Commit to this branch
• Create a new PR

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{A rabbit finds the specs in view,
With links for GeoIP and minFraud too.
Through docs and menus, paths appear,
API details now draw near.
I hop along, then nibble a leaf.}

_{Comment @coderabbitai help to get the list of available commands.}

[cloudflare-workers-and-pages]

Deploying dev-site with    Cloudflare Pages

Latest commit:	d70f51a
Status:	✅  Deploy successful!
Preview URL:	https://5f0d53f2.dev-site-4ua.pages.dev
Branch Preview URL:	https://greg-openapi.dev-site-4ua.pages.dev

View logs