# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Confluence Cloud REST API v2 Custom Content API
  version: 1.0.0
extends: openapi/confluence-custom-content-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: 8
- target: $.paths['/blogposts/{id}/custom-content'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom content of a type in a blog post
      effect: read
      questions:
      - What custom content of a given type is attached to a blog post?
      - Can I list an app's custom content inside one blog post?
      instructions:
      - text: List custom content of type {type} in blog post {id}.
        slots:
          type: query.type
          id: path.id
      - text: Show the {type} items stored within blog post {id}.
        slots:
          type: query.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom content of a type
      effect: read
      questions:
      - How do I find all custom content of a given type across the site?
      - Can I filter custom content of one type to specific spaces?
      instructions:
      - text: List all custom content of type {type}.
        slots:
          type: query.type
      - text: Get custom content of type {type} in spaces {spaces}.
        slots:
          type: query.type
          spaces: query.space-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content'].post
  update:
    x-apievangelist-phrasing:
      intent: Create custom content
      effect: write
      questions:
      - How do I create a custom content item for my app?
      - Can I attach new custom content to a page instead of a space?
      instructions:
      - text: Create custom content of type {type} titled {title} in space {spaceId} with body {body}.
        slots:
          type: requestBody.type
          title: requestBody.title
          spaceId: requestBody.spaceId
          body: requestBody.body
      - text: Add a {type} custom content item {title} to page {pageId} with body {body}.
        slots:
          type: requestBody.type
          title: requestBody.title
          pageId: requestBody.pageId
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom content item
      effect: read
      questions:
      - How do I fetch one custom content item by its ID?
      - Can I include labels and properties when reading custom content?
      instructions:
      - text: Get custom content {id}.
        slots:
          id: path.id
      - text: Fetch custom content {id} at version {version}.
        slots:
          id: path.id
          version: query.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom content item
      effect: write
      questions:
      - How do I edit an existing custom content item?
      - Which version number must I send when updating custom content?
      instructions:
      - text: Update custom content {id} of type {type} to version {version} with title {title}, status {status} and body {body}.
        slots:
          id: path.id
          type: requestBody.type
          version: requestBody.version
          title: requestBody.title
          status: requestBody.status
          body: requestBody.body
      - text: Change the body of {type} custom content {id} to {body}, saving version {version} titled {title} as {status}.
        slots:
          id: path.id
          type: requestBody.type
          version: requestBody.version
          title: requestBody.title
          status: requestBody.status
          body: requestBody.body
      method: generated
      generated: '2026-10-01'
- target: $.paths['/custom-content/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom content item
      effect: destructive
      questions:
      - Does deleting custom content send it to the trash or remove it for good?
      - Can I purge custom content that's already in the trash?
      instructions:
      - text: Delete custom content {id}.
        slots:
          id: path.id
      - text: Permanently purge trashed custom content {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/custom-content'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom content of a type in a page
      effect: read
      questions:
      - What custom content of a given type lives inside a page?
      - Can I list my app's custom content items on one page?
      instructions:
      - text: List custom content of type {type} in page {id}.
        slots:
          type: query.type
          id: path.id
      - text: Show the {type} items stored within page {id}.
        slots:
          type: query.type
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/custom-content'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom content of a type in a space
      effect: read
      questions:
      - Which custom content items of a type belong to a space?
      - Can I page through a space's custom content of one type?
      instructions:
      - text: List custom content of type {type} in space {id}.
        slots:
          type: query.type
          id: path.id
      - text: Show the first {limit} {type} items in space {id}.
        slots:
          type: query.type
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'