# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Website Sitemaps API
  version: 1.0.0
extends: openapi/optimizely-website-sitemaps-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/WebsiteSitemaps'].get
  update:
    x-apievangelist-phrasing:
      intent: List website sitemaps
      effect: read
      questions:
      - Which XML sitemaps have been generated for my storefront websites?
      - Can I filter sitemaps by domain or microsite?
      - What sitemap files exist for a given website?
      instructions:
      - text: List all website sitemaps.
      - text: Find sitemaps matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} sitemaps with only fields {select}.
        slots:
          top: query.$top
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteSitemaps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a website sitemap
      effect: write
      questions:
      - How do I store a new XML sitemap for a domain?
      - What fields does a sitemap record need, like filename and job ID?
      instructions:
      - text: Create sitemap {filename} for domain {domain} and microsite {micrositeIdentifier} with XML {xml} from job {jobId}.
        slots:
          filename: requestBody.filename
          domain: requestBody.domain
          micrositeIdentifier: requestBody.micrositeIdentifier
          xml: requestBody.xml
          jobId: requestBody.jobId
      - text: Add a sitemap file {filename} for website {websiteId}.
        slots:
          filename: requestBody.filename
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteSitemaps({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a website sitemap
      effect: read
      questions:
      - What XML does a particular sitemap record contain?
      - Which domain and job produced a specific sitemap?
      instructions:
      - text: Get website sitemap {id}.
        slots:
          id: path.id
      - text: Show the XML and domain of sitemap {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteSitemaps({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a website sitemap
      effect: write
      questions:
      - How do I overwrite a sitemap record with regenerated XML?
      - Does replacing a sitemap reset fields I do not send?
      instructions:
      - text: Replace sitemap {id} with XML {xml} and filename {filename}.
        slots:
          id: path.id
          xml: requestBody.xml
          filename: requestBody.filename
      - text: Overwrite website sitemap {id} in full for domain {domain}.
        slots:
          id: path.id
          domain: requestBody.domain
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteSitemaps({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a website sitemap
      effect: destructive
      questions:
      - How do I delete an outdated sitemap?
      - Can deleting a sitemap require a matching ETag?
      instructions:
      - text: Delete website sitemap {id}.
        slots:
          id: path.id
      - text: Delete sitemap {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteSitemaps({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a website sitemap
      effect: write
      questions:
      - Can I swap in new XML on a sitemap without resending the rest?
      - How do I rename a sitemap file?
      instructions:
      - text: Update the XML of sitemap {id} to {xml}.
        slots:
          id: path.id
          xml: requestBody.xml
      - text: Rename website sitemap {id} to file {filename}.
        slots:
          id: path.id
          filename: requestBody.filename
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/WebsiteSitemaps/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank sitemap template
      effect: read
      questions:
      - What default values does a new sitemap record start with?
      - Is there an empty website sitemap template to fetch?
      instructions:
      - text: Fetch the default website sitemap template.
      - text: Show default field values for a new sitemap.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitesitemaps/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete website sitemaps
      effect: destructive
      questions:
      - How do I delete many sitemaps at once?
      - Can I purge a list of sitemap records by ID?
      instructions:
      - text: Bulk delete website sitemaps {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these sitemaps in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/websitesitemaps({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a sitemap
      effect: read
      questions:
      - What value is stored in a custom property on a website sitemap?
      - Can I read one custom property of a sitemap record?
      instructions:
      - text: Get custom property {custompropertyKey} on sitemap {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show website sitemap {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'