Add Geo Sites API documentation
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:
-
Add GeoSite and GeoSiteStatus grape entities— Merged✅ -
Add geo sites fixtures schemas— Merged✅ -
Add geo_sites API endpoint- Merged✅ - This MR: Add Geo Sites API documentation
- Add deprecation warning to Geo Nodes API doc
- Add deprecation notice for geo_nodes API endpoints
- Add geo_sites documentation to the nav bar
Screenshots or screen recordings
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.
-
I have evaluated the MR acceptance checklist for this MR.
Related to #369140
Edited by Gabriel Mazetto