Google Search Console · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Google Search Console Sites API

5 actions 5 updates phrasing extends openapi/google-search-console-sites-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'].get

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

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

$.paths['/webmasters/v3/sites/{siteUrl}'].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 Sites API
  version: 1.0.0
extends: openapi/google-search-console-sites-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'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Search Console properties
      effect: read
      questions:
      - Which websites do I have access to in Search Console?
      - Can I see every property I'm verified for or was delegated access to?
      instructions:
      - text: List all my Search Console sites.
      - text: Show every property my account can access in Search Console.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webmasters/v3/sites/{siteUrl}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check my permission level on a site
      effect: read
      questions:
      - What permission level do I have on a particular Search Console property?
      - Am I an owner or just a restricted user on this site?
      instructions:
      - text: Get the details and my permission level for {siteUrl}.
        slots:
          siteUrl: path.siteUrl
      - text: Check what access I have to the property {siteUrl}.
        slots:
          siteUrl: path.siteUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webmasters/v3/sites/{siteUrl}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a site to Search Console
      effect: write
      questions:
      - How do I add a new website or domain property to my Search Console account?
      - Do I still need to verify a site after adding it through the API?
      instructions:
      - text: Add {siteUrl} to my Search Console sites.
        slots:
          siteUrl: path.siteUrl
      - text: Register the property {siteUrl} in my Search Console account.
        slots:
          siteUrl: path.siteUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/webmasters/v3/sites/{siteUrl}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a site from Search Console
      effect: destructive
      questions:
      - How can I take a property off my Search Console site list?
      - Does removing a site from my account delete its Search Console data?
      instructions:
      - text: Remove {siteUrl} from my Search Console sites.
        slots:
          siteUrl: path.siteUrl
      - text: Drop the property {siteUrl} from my account's site list.
        slots:
          siteUrl: path.siteUrl
      method: generated
      generated: '2026-10-01'