Google Search Console · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Search Console Sitemaps API

5 actions 5 updates phrasing extends openapi/google-search-console-sitemaps-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Google Search Console's API. It is a proposal applied on top of the contract, not a document Google Search Console publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/webmasters/v3/sites/{siteUrl}/sitemaps'].get

$.paths['/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'].get

$.paths['/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'].put

$.paths['/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Google Search Console Sitemaps API
  version: 1.0.0
extends: openapi/google-search-console-sitemaps-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/webmasters/v3/sites/{siteUrl}/sitemaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List the sitemaps submitted for a site
      effect: read
      questions:
      - Which sitemaps has Google picked up for my site, including ones found through robots.txt?
      - Can I see only the sitemaps listed inside one particular sitemap index?
      - What sitemaps are registered for my Search Console property right now?
      instructions:
      - text: List all sitemaps submitted for {siteUrl}.
        slots:
          siteUrl: path.siteUrl
      - text: Show the sitemaps for {siteUrl} that belong to the sitemap index {sitemapIndex}.
        slots:
          siteUrl: path.siteUrl
          sitemapIndex: query.sitemapIndex
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one sitemap
      effect: read
      questions:
      - Did Google report errors or warnings when it processed my sitemap?
      - When was a specific sitemap last submitted and how many URLs does it contain?
      - What processing status does one of my sitemaps have in Search Console?
      instructions:
      - text: Get the processing details for sitemap {feedpath} on {siteUrl}.
        slots:
          siteUrl: path.siteUrl
          feedpath: path.feedpath
      - text: Show me the error and warning counts for {feedpath} on property {siteUrl}.
        slots:
          siteUrl: path.siteUrl
          feedpath: path.feedpath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'].put
  update:
    x-apievangelist-phrasing:
      intent: Submit or resubmit a sitemap
      effect: write
      questions:
      - How do I tell Google about a new sitemap for my site?
      - Can I resubmit a sitemap so Google reprocesses it after I changed it?
      - Does submitting a sitemap index also submit every sitemap listed in it?
      instructions:
      - text: Submit the sitemap {feedpath} for {siteUrl}.
        slots:
          siteUrl: path.siteUrl
          feedpath: path.feedpath
      - text: Resubmit {feedpath} on {siteUrl} so Google processes it again.
        slots:
          siteUrl: path.siteUrl
          feedpath: path.feedpath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a sitemap from Search Console
      effect: destructive
      questions:
      - How do I remove an old sitemap from my Search Console list?
      - Will deleting a sitemap stop Google from crawling the URLs it contained?
      instructions:
      - text: Delete the sitemap {feedpath} from {siteUrl} in Search Console.
        slots:
          siteUrl: path.siteUrl
          feedpath: path.feedpath
      - text: Remove {feedpath} from the submitted sitemaps of {siteUrl}.
        slots:
          siteUrl: path.siteUrl
          feedpath: path.feedpath
      method: generated
      generated: '2026-10-01'