Box Platform API — File Version Retentions

naftiko: 1.0.0-alpha2
info:
  label: Box Platform API — File Version Retentions
  description: 'Box Platform API — File Version Retentions. 2 operations. Lead operation: Box List file version retentions.
    Self-contained Naftiko capability covering one Box business surface.'
  tags:
  - Box
  - File Version Retentions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BOX_API_KEY: BOX_API_KEY
capability:
  consumes:
  - type: http
    namespace: box-file-version-retentions
    baseUri: https://api.box.com/2.0
    description: Box Platform API — File Version Retentions business capability. Self-contained, no shared references.
    resources:
    - name: file_version_retentions
      path: /file_version_retentions
      operations:
      - name: getfileversionretentions
        method: GET
        description: Box List file version retentions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file_id
          in: query
          type: string
          description: Filters results by files with this ID.
        - name: file_version_id
          in: query
          type: string
          description: Filters results by file versions with this ID.
        - name: policy_id
          in: query
          type: string
          description: Filters results by the retention policy with this ID.
        - name: disposition_action
          in: query
          type: string
          description: Filters results by the retention policy with this disposition
        - name: disposition_before
          in: query
          type: string
          description: Filters results by files that will have their disposition
        - name: disposition_after
          in: query
          type: string
          description: Filters results by files that will have their disposition
        - name: limit
          in: query
          type: integer
          description: The maximum number of items to return per page.
        - name: marker
          in: query
          type: string
          description: Defines the position marker at which to begin returning results. This is
    - name: file_version_retentions-file_version_retention_id
      path: /file_version_retentions/{file_version_retention_id}
      operations:
      - name: getfileversionretentionsid
        method: GET
        description: Box Get retention on file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file_version_retention_id
          in: path
          type: string
          description: The ID of the file version retention
          required: true
    authentication:
      type: bearer
      token: '{{env.BOX_API_KEY}}'
  exposes:
  - type: rest
    namespace: box-file-version-retentions-rest
    port: 8080
    description: REST adapter for Box Platform API — File Version Retentions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/file-version-retentions
      name: file-version-retentions
      description: REST surface for file_version_retentions.
      operations:
      - method: GET
        name: getfileversionretentions
        description: Box List file version retentions
        call: box-file-version-retentions.getfileversionretentions
        with:
          file_id: rest.file_id
          file_version_id: rest.file_version_id
          policy_id: rest.policy_id
          disposition_action: rest.disposition_action
          disposition_before: rest.disposition_before
          disposition_after: rest.disposition_after
          limit: rest.limit
          marker: rest.marker
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/file-version-retentions/{file-version-retention-id}
      name: file-version-retentions-file-version-retention-id
      description: REST surface for file_version_retentions-file_version_retention_id.
      operations:
      - method: GET
        name: getfileversionretentionsid
        description: Box Get retention on file
        call: box-file-version-retentions.getfileversionretentionsid
        with:
          file_version_retention_id: rest.file_version_retention_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: box-file-version-retentions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Box Platform API — File Version Retentions. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: box-list-file-version-retentions
      description: Box List file version retentions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-file-version-retentions.getfileversionretentions
      with:
        file_id: tools.file_id
        file_version_id: tools.file_version_id
        policy_id: tools.policy_id
        disposition_action: tools.disposition_action
        disposition_before: tools.disposition_before
        disposition_after: tools.disposition_after
        limit: tools.limit
        marker: tools.marker
      outputParameters:
      - type: object
        mapping: $.
    - name: box-get-retention-file
      description: Box Get retention on file
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: box-file-version-retentions.getfileversionretentionsid
      with:
        file_version_retention_id: tools.file_version_retention_id
      outputParameters:
      - type: object
        mapping: $.