Fetch the changelog sitemap

Goal

Serve a Sitemaps 0.9 XML sitemap of every public changelog release and entry so search engines (Google, Bing, DuckDuckGo) can crawl and index them efficiently. Useful when Veriko is white-labeled into a customer docs site whose root sitemap should include the changelog.

Prerequisites

None for fetching the sitemap. Submission to search engines requires ownership of the docs domain in the engine's webmaster panel.

Steps

1. Fetch the sitemap

curl 'https://api.veriko.mx/v1/public/changelog/sitemap.xml'

Response (200):

<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
  <url>
    <loc>https://docs.veriko.mx/en/changelog/1.49.6</loc>
    <lastmod>2026-05-28</lastmod>
    <changefreq>monthly</changefreq>
    <priority>0.6</priority>
  </url>
  <url>
    <loc>https://docs.veriko.mx/en/changelog/1.49.6/example-entry</loc>
    <lastmod>2026-05-28</lastmod>
    <changefreq>monthly</changefreq>
    <priority>0.4</priority>
  </url>
  <!-- ... one <url> per public release entry ... -->
</urlset>

2. Submit to Google Search Console

  1. Open the Search Console sitemap submission page.
  2. Select your verified docs property.
  3. Under "Sitemaps", add the URL: https://api.veriko.mx/v1/public/changelog/sitemap.xml.
  4. Click "Submit". Google crawls the sitemap within a few hours.

3. Submit to Bing Webmaster Tools

  1. Open Bing Webmaster Tools.
  2. Under "Sitemaps", add the same URL.
  3. Click "Submit".

4. (Optional) Switch language

curl 'https://api.veriko.mx/v1/public/changelog/sitemap.xml?lang=es'

The <loc> URLs change locale (e.g. https://docs.veriko.mx/es/changelog/...). Submit one sitemap per language if your docs are dual-published.

Errors

StatusCodeCause
429rate_limit_exceededToo many sitemap fetches. Search engines never trigger this; the cause is usually a misconfigured polling script.

Notes

  • A lang other than es/en is not an error: en is served.
  • The sitemap only includes public entries. Embargoed and unpublished entries are excluded.
  • Search engines crawl sitemaps at their own pace (typically once per day for active sites). Do not poll this endpoint from your own automation — use the Atom or JSON feed instead.
  • These routes live under /v1/public/*, the namespace reserved for the public catalogue served without authentication.