# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Novu Contexts API
  version: 1.0.0
extends: openapi/novu-contexts-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: 5
- target: $.paths['/v2/contexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List contexts
      effect: read
      questions:
      - How do I see all the contexts defined in my Novu environment?
      - Can I search contexts by a key pattern?
      - Is there a way to page through contexts with a cursor?
      instructions:
      - text: List all contexts.
      - text: Find contexts whose key matches {search}.
        slots:
          search: query.search
      - text: List contexts with id {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/contexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a context
      effect: write
      questions:
      - How do I create a new context with a type, id and custom data?
      - What happens if I create a context that already exists?
      instructions:
      - text: Create a context of type {type} with id {id}.
        slots:
          type: requestBody.type
          id: requestBody.id
      - text: Create a new {type} context {id} holding data {data}.
        slots:
          type: requestBody.type
          id: requestBody.id
          data: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/contexts/{type}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a context
      effect: read
      questions:
      - How do I fetch a single context by its type and id?
      - What data is stored on a specific context right now?
      instructions:
      - text: Show me the {type} context {id}.
        slots:
          type: path.type
          id: path.id
      - text: Retrieve the stored data for context {id} of type {type}.
        slots:
          id: path.id
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/contexts/{type}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a context
      effect: destructive
      questions:
      - How do I remove a context I no longer need?
      - Can I delete a context by giving its type and id?
      instructions:
      - text: Delete the {type} context {id}.
        slots:
          type: path.type
          id: path.id
      - text: Remove context {id} of type {type} permanently.
        slots:
          id: path.id
          type: path.type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/contexts/{type}/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a context's data
      effect: write
      questions:
      - How do I change the data on an existing context without recreating it?
      - Does updating a context touch anything besides its data field?
      instructions:
      - text: Replace the data on {type} context {id} with {data}.
        slots:
          type: path.type
          id: path.id
          data: requestBody.data
      - text: Update existing context {id} of type {type} to hold {data}.
        slots:
          id: path.id
          type: path.type
          data: requestBody.data
      method: generated
      generated: '2026-09-26'