# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Scenes API
  version: 1.0.0
extends: openapi/microsoft-azure-scenes-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: 6
- target: $.paths['/scenes'].get
  update:
    x-apievangelist-phrasing:
      intent: List satellite scenes for a boundary
      effect: read
      questions:
      - Which Sentinel-2 satellite scenes cover one of my field boundaries?
      - Can I filter scenes by maximum cloud coverage?
      instructions:
      - text: List {source} scenes from {provider} for party {party}, boundary {boundary}.
        slots:
          source: query.source
          provider: query.provider
          party: query.partyId
          boundary: query.boundaryId
      - text: Show {source} scenes for boundary {boundary} of party {party} from {provider} under {cloud}% cloud.
        slots:
          source: query.source
          boundary: query.boundaryId
          party: query.partyId
          provider: query.provider
          cloud: query.maxCloudCoveragePercentage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scenes/downloadFiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a scene file
      effect: read
      questions:
      - How do I download the image file for a satellite scene?
      - Can I stream a scene file from its storage path?
      instructions:
      - text: Download the scene file at {path}.
        slots:
          path: query.filePath
      - text: Fetch the satellite image stored at {path}.
        slots:
          path: query.filePath
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scenes/satellite/ingest-data/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a satellite data ingestion job
      effect: read
      questions:
      - Has my satellite data ingestion job finished?
      - Why did a satellite ingestion job fail?
      instructions:
      - text: Get satellite ingestion job {job}.
        slots:
          job: path.jobId
      - text: Show the status of satellite data job {job}.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scenes/satellite/ingest-data/{jobId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Start a satellite data ingestion job
      effect: write
      questions:
      - How do I pull Sentinel-2 imagery for a field boundary into Data Manager for Agriculture?
      - Can I ingest satellite data for a specific date range?
      instructions:
      - text: Start ingestion job {job} for party {party}, boundary {boundary}, source {source}, {start} to {end}.
        slots:
          job: path.jobId
          party: requestBody.partyId
          boundary: requestBody.boundaryId
          source: requestBody.source
          start: requestBody.startDateTime
          end: requestBody.endDateTime
      - text: Ingest {source} satellite data as job {job} for boundary {boundary} of party {party} from {start} to {end}.
        slots:
          source: requestBody.source
          job: path.jobId
          boundary: requestBody.boundaryId
          party: requestBody.partyId
          start: requestBody.startDateTime
          end: requestBody.endDateTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scenes/stac-collections/{collectionId}:search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search STAC features in a collection
      effect: read
      questions:
      - Can I search a STAC collection by bounding box and date range?
      - Which STAC items intersect my area of interest?
      instructions:
      - text: Search STAC collection {collection} for features between {start} and {end}.
        slots:
          collection: path.collectionId
          start: requestBody.startDateTime
          end: requestBody.endDateTime
      - text: Find features in {collection} within bbox {bbox} from {start} to {end}.
        slots:
          collection: path.collectionId
          bbox: requestBody.bbox
          start: requestBody.startDateTime
          end: requestBody.endDateTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/scenes/stac-collections/{collectionId}/features/{featureId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a STAC feature
      effect: read
      questions:
      - How do I fetch one STAC item by its feature id?
      - What assets are attached to a specific STAC feature?
      instructions:
      - text: Get STAC feature {feature} from collection {collection}.
        slots:
          feature: path.featureId
          collection: path.collectionId
      - text: Show item {feature} in STAC collection {collection}.
        slots:
          feature: path.featureId
          collection: path.collectionId
      method: generated
      generated: '2026-09-26'