# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for App Store Connect Review Submissions API
  version: 1.0.0
extends: openapi/ios-reviewsubmissions-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: 6
- target: $.paths['/v1/reviewSubmissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's App Review submissions
      effect: read
      questions:
      - Which submissions to App Review exist for my app?
      - Can I see only submissions that are waiting for review or in review?
      instructions:
      - text: List the review submissions for app {app}.
        slots:
          app: query.filter[app]
      - text: Show review submissions for app {app} in state {state} on {platform}.
        slots:
          app: query.filter[app]
          state: query.filter[state]
          platform: query.filter[platform]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reviewSubmissions'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new App Review submission
      effect: write
      questions:
      - How do I start a submission to send my app to App Review?
      - Can I create one review submission for a specific platform of my app?
      instructions:
      - text: Create a review submission {submission}.
        slots:
          submission: requestBody.data
      - text: Start a new App Review submission for app and platform {submission}.
        slots:
          submission: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reviewSubmissions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an App Review submission
      effect: read
      questions:
      - What state is a specific review submission in right now?
      - When was my review submission sent and on which platform?
      instructions:
      - text: Get review submission {submission}.
        slots:
          submission: path.id
      - text: Check the status of review submission {submission}.
        slots:
          submission: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reviewSubmissions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Submit or cancel an App Review submission
      effect: write
      questions:
      - How do I actually submit a prepared review submission to App Review?
      - Can I cancel a review submission I already sent?
      instructions:
      - text: Submit review submission {submission} with {changes}.
        slots:
          submission: path.id
          changes: requestBody.data
      - text: Update review submission {submission} to {changes}.
        slots:
          submission: path.id
          changes: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reviewSubmissions/{id}/relationships/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List item IDs in a review submission
      effect: read
      questions:
      - Can I get only the IDs of the items inside a review submission?
      - Which item identifiers are part of a submission?
      instructions:
      - text: Get the item IDs in review submission {submission}.
        slots:
          submission: path.id
      - text: Return just the item linkages of review submission {submission}.
        slots:
          submission: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/reviewSubmissions/{id}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in a review submission
      effect: read
      questions:
      - What versions, events or product pages are included in my review submission?
      - Which items in a submission were accepted or rejected?
      instructions:
      - text: List the items in review submission {submission}.
        slots:
          submission: path.id
      - text: Show every item and its state in review submission {submission}.
        slots:
          submission: path.id
      method: generated
      generated: '2026-10-01'