Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST API v2 Classification Level API

17 actions 17 updates phrasing extends openapi/confluence-classification-level-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 17 · first 16 shown; the file carries all of them

$.info
$.paths['/classification-levels'].get
$.paths['/spaces/{id}/classification-level/default'].get
$.paths['/spaces/{id}/classification-level/default'].put
$.paths['/spaces/{id}/classification-level/default'].delete
$.paths['/pages/{id}/classification-level'].get
$.paths['/pages/{id}/classification-level'].put
$.paths['/pages/{id}/classification-level/reset'].post
$.paths['/blogposts/{id}/classification-level'].get
$.paths['/blogposts/{id}/classification-level'].put
$.paths['/blogposts/{id}/classification-level/reset'].post
$.paths['/whiteboards/{id}/classification-level'].get
$.paths['/whiteboards/{id}/classification-level'].put
$.paths['/whiteboards/{id}/classification-level/reset'].post
$.paths['/databases/{id}/classification-level'].get
$.paths['/databases/{id}/classification-level'].put

OpenAPI Overlay

Raw ↑
# 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 Classification Level API
  version: 1.0.0
extends: openapi/confluence-classification-level-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: 16
- target: $.paths['/classification-levels'].get
  update:
    x-apievangelist-phrasing:
      intent: List available classification levels
      effect: read
      questions:
      - Which data classification levels are available on my Confluence site?
      - What classification labels can I choose from when tagging sensitive content?
      instructions:
      - text: List all the classification levels defined for this site.
      - text: Show me every classification level I could apply to content.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/classification-level/default'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a space's default classification level
      effect: read
      questions:
      - What classification level do new pages in a space get by default?
      - Can I check which default classification a space is set to?
      instructions:
      - text: Get the default classification level for space {id}.
        slots:
          id: path.id
      - text: Tell me which classification space {id} applies by default.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/classification-level/default'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a space's default classification level
      effect: write
      questions:
      - How do I change the default classification level for a whole space?
      - Can I make every new page in a space default to a stricter classification?
      instructions:
      - text: Set the default classification of space {id} to level {level}.
        slots:
          id: path.id
          level: requestBody.id
      - text: Change space {id}'s default classification level to {level}.
        slots:
          id: path.id
          level: requestBody.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/spaces/{id}/classification-level/default'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a space's default classification level
      effect: destructive
      questions:
      - Can I clear the default classification level from a space?
      - What happens if I remove a space's default classification setting?
      instructions:
      - text: Remove the default classification level from space {id}.
        slots:
          id: path.id
      - text: Clear space {id} so it no longer has a default classification.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/classification-level'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page's classification level
      effect: read
      questions:
      - What classification level is a specific page marked with?
      - Can I see the classification of a page's draft rather than the published version?
      instructions:
      - text: Get the classification level of page {id}.
        slots:
          id: path.id
      - text: Show the classification on the {status} version of page {id}.
        slots:
          id: path.id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/classification-level'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a page's classification level
      effect: write
      questions:
      - How do I mark a single page as confidential?
      - Can I change the classification on a page's draft separately from its published version?
      instructions:
      - text: Classify page {id} as level {level}.
        slots:
          id: path.id
          level: requestBody.id
      - text: Set the classification of the {status} page {id} to {level}.
        slots:
          id: path.id
          level: requestBody.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/pages/{id}/classification-level/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a page to the space default classification
      effect: write
      questions:
      - How do I make a page go back to its space's default classification?
      - Can I undo a custom classification I put on a page?
      instructions:
      - text: Reset page {id} to the space default classification level.
        slots:
          id: path.id
      - text: Revert the {status} version of page {id} to the space's default classification.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/classification-level'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog post's classification level
      effect: read
      questions:
      - What classification level does a blog post carry?
      - Is there a way to read the classification of a blog post draft?
      instructions:
      - text: Get the classification level of blog post {id}.
        slots:
          id: path.id
      - text: Show the classification on the {status} version of blog post {id}.
        slots:
          id: path.id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/classification-level'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a blog post's classification level
      effect: write
      questions:
      - How do I classify a blog post as internal only?
      - Can I change the classification level on a published blog post?
      instructions:
      - text: Classify blog post {id} as level {level}.
        slots:
          id: path.id
          level: requestBody.id
      - text: Set the classification of the {status} blog post {id} to {level}.
        slots:
          id: path.id
          level: requestBody.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/blogposts/{id}/classification-level/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a blog post to the space default classification
      effect: write
      questions:
      - Can I put a blog post back on its space's default classification?
      - What's the way to drop a custom classification from a blog post?
      instructions:
      - text: Reset blog post {id} to the space default classification level.
        slots:
          id: path.id
      - text: Revert the {status} version of blog post {id} to the space default classification.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}/classification-level'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a whiteboard's classification level
      effect: read
      questions:
      - What classification level is a whiteboard tagged with?
      - Can I check whether a whiteboard is marked confidential?
      instructions:
      - text: Get the classification level of whiteboard {id}.
        slots:
          id: path.id
      - text: Tell me how whiteboard {id} is classified.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}/classification-level'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a whiteboard's classification level
      effect: write
      questions:
      - How do I change the classification of a whiteboard?
      - Can I mark a whiteboard as restricted data?
      instructions:
      - text: Classify whiteboard {id} as level {level}.
        slots:
          id: path.id
          level: requestBody.id
      - text: Set the {status} whiteboard {id} to classification level {level}.
        slots:
          id: path.id
          level: requestBody.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/whiteboards/{id}/classification-level/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a whiteboard to the space default classification
      effect: write
      questions:
      - Can I put a whiteboard back on the space's default classification?
      - Is there a way to remove a custom classification from a whiteboard?
      instructions:
      - text: Reset whiteboard {id} to the space default classification level.
        slots:
          id: path.id
      - text: Revert the {status} whiteboard {id} to its space's default classification.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/classification-level'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database's classification level
      effect: read
      questions:
      - What classification level is a Confluence database marked with?
      - Can I look up how a database is classified?
      instructions:
      - text: Get the classification level of database {id}.
        slots:
          id: path.id
      - text: Tell me how database {id} is classified.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/classification-level'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a database's classification level
      effect: write
      questions:
      - How do I classify a Confluence database as sensitive?
      - Can I change the classification level on a database?
      instructions:
      - text: Classify database {id} as level {level}.
        slots:
          id: path.id
          level: requestBody.id
      - text: Set the {status} database {id} to classification level {level}.
        slots:
          id: path.id
          level: requestBody.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/{id}/classification-level/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a database to the space default classification
      effect: write
      questions:
      - Can I put a database back on its space's default classification?
      - What's the way to drop a custom classification from a database?
      instructions:
      - text: Reset database {id} to the space default classification level.
        slots:
          id: path.id
      - text: Revert the {status} database {id} to the space's default classification.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-10-01'