Skip to content

Add Geo Sites API documentation

Mariia Solodovnik requested to merge 369140-add-geo-sites-api-documentation-page into master

What does this MR do and why?

As a part of renaming geo_nodes API endpoint to the geo_sites, add a new documentation for Geo Sites API that will gradually supersede Geo Nodes.

This new page is also referenced by the Geo Node API in the !116438 (merged) that adds a deprecation warning for that page.

This MR is a part of the issue Geo: New API endpoint for geo_sites to supersede geo_nodes

The issue is split into several MRs that should be merged in sequential order:

  1. Add GeoSite and GeoSiteStatus grape entities — Merged ✅
  2. Add geo sites fixtures schemas — Merged ✅
  3. Add geo_sites API endpoint - Merged ✅
  4. This MR: Add Geo Sites API documentation
  5. Add deprecation warning to Geo Nodes API doc
  6. Add deprecation notice for geo_nodes API endpoints
  7. Add geo_sites documentation to the nav bar

Screenshots or screen recordings

image

How to set up and validate locally

Check a new page on /help/api/geo_sites.html

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #369140

Edited by Gabriel Mazetto

Merge request reports