# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Onetrust Inventory Schema API
  version: 1.0.0
extends: openapi/onetrust-inventory-schema-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/inventory/v2/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List inventory schemas
      effect: read
      questions:
      - Which inventory schemas are defined in my tenant?
      - Can I see every schema available for inventories?
      instructions:
      - text: List all inventory schemas.
      - text: Show me the schemas my inventories use.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/schemas/attributes/{attributeId}/values/bulk/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add options to a select attribute
      effect: write
      questions:
      - Can I bulk-add dropdown options to a single or multi select inventory attribute?
      - Which attribute types support creating new option values?
      instructions:
      - text: Create option values for attribute {attributeId}.
        slots:
          attributeId: path.attributeId
      - text: Bulk add new select options to inventory attribute {attributeId}.
        slots:
          attributeId: path.attributeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/schemas/attributes/{attributeId}/values/{valueId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or deactivate an attribute option
      effect: write
      questions:
      - Can I rename an existing option on an inventory attribute?
      - Is it possible to deactivate a single option value on one attribute without deleting it?
      instructions:
      - text: Rename option {valueId} on attribute {attributeId} to {Value}.
        slots:
          valueId: path.valueId
          attributeId: path.attributeId
          Value: requestBody.Value
      - text: Set status {Status} on option {valueId} of attribute {attributeId} with value {Value}.
        slots:
          Status: requestBody.Status
          valueId: path.valueId
          attributeId: path.attributeId
          Value: requestBody.Value
      method: generated
      generated: '2026-10-02'
- target: $.paths['/api/inventory/v2/schemas/{schemaName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an inventory schema with hidden fields
      effect: read
      questions:
      - Can I fetch a schema by name including hidden attributes?
      - Does a schema lookup by name return personal data attributes too?
      instructions:
      - text: Get the inventory schema {schemaName}.
        slots:
          schemaName: path.schemaName
      - text: Get schema {schemaName} including hidden attributes {includeHidden} and personal data {includePersonalData}.
        slots:
          schemaName: path.schemaName
          includeHidden: query.includeHidden
          includePersonalData: query.includePersonalData
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/schemas/{schemaName}/attributes/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an inventory attribute
      effect: write
      questions:
      - Can I add a custom attribute to the assets or vendors schema?
      - What response types can a new inventory attribute have?
      instructions:
      - text: Create attribute {name} on schema {schemaName} with response type {responseType} and description {description}.
        slots:
          name: requestBody.name
          schemaName: path.schemaName
          responseType: requestBody.responseType
          description: requestBody.description
      - text: Add a {responseType} field called {name} to the {schemaName} schema, described as {description}.
        slots:
          responseType: requestBody.responseType
          name: requestBody.name
          schemaName: path.schemaName
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/schemas/{schemaName}/attributes/activate'].put
  update:
    x-apievangelist-phrasing:
      intent: Activate inventory attributes
      effect: write
      questions:
      - Can I re-enable attributes on a schema by their field names?
      - Is there a bulk way to turn inactive schema attributes back on?
      instructions:
      - text: Activate attributes by field name on schema {schemaName}.
        slots:
          schemaName: path.schemaName
      - text: Turn deactivated fields back on for the {schemaName} schema.
        slots:
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/schemas/{schemaName}/attributes/deactivate'].put
  update:
    x-apievangelist-phrasing:
      intent: Deactivate inventory attributes
      effect: write
      questions:
      - Can I switch off attributes on a schema by their field names?
      - Is there a bulk way to hide attributes I no longer use?
      instructions:
      - text: Deactivate attributes by field name on schema {schemaName}.
        slots:
          schemaName: path.schemaName
      - text: Switch off unused fields in the {schemaName} schema.
        slots:
          schemaName: path.schemaName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/inventory/v2/schemas/{schemaName}/attributes/{fieldName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attribute's schema details
      effect: read
      questions:
      - What are the settings and options of a single attribute in a schema?
      - Can I limit how many options come back for one schema field?
      instructions:
      - text: Get details of field {fieldName} in schema {schemaName}.
        slots:
          fieldName: path.fieldName
          schemaName: path.schemaName
      - text: Show field {fieldName} of schema {schemaName} with up to {optionsSize} options.
        slots:
          fieldName: path.fieldName
          schemaName: path.schemaName
          optionsSize: query.optionsSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/v2/schemas/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get attribute definitions for an inventory type
      effect: read
      questions:
      - What attributes, types and validation rules does an inventory type have?
      - Where can I learn the structure of an inventory category before importing records?
      instructions:
      - text: Get the attribute definitions for inventory type {type}.
        slots:
          type: path.type
      - text: Show validation rules for all attributes of inventory type {type}, show all {showAll}.
        slots:
          type: path.type
          showAll: query.showAll
      method: generated
      generated: '2026-09-26'