naftiko: 1.0.0-alpha2
info:
  label: API Reference — subpackage_permissions.subpackage_permissions/roles
  description: 'API Reference — subpackage_permissions.subpackage_permissions/roles. 5 operations. Lead operation: List Roles.
    Self-contained Naftiko capability covering one Polytomic business surface.'
  tags:
  - Polytomic
  - subpackage_permissions.subpackage_permissions/roles
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    POLYTOMIC_API_KEY: POLYTOMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: polytomic-subpackage-permissions-subpackage-permissions-roles
    baseUri: https://app.polytomic.com
    description: API Reference — subpackage_permissions.subpackage_permissions/roles business capability. Self-contained,
      no shared references.
    resources:
    - name: api-permissions-roles
      path: /api/permissions/roles
      operations:
      - name: list
        method: GET
        description: List Roles
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: create
        method: POST
        description: Create Role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-permissions-roles-id
      path: /api/permissions/roles/{id}
      operations:
      - name: get
        method: GET
        description: Get Role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
      - name: update
        method: PUT
        description: Update Role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: Delete Role
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: Authorization
          in: header
          type: string
          description: Bearer user API key
          required: true
        - name: X-Polytomic-Version
          in: header
          type: string
    authentication:
      type: bearer
      token: '{{env.POLYTOMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: polytomic-subpackage-permissions-subpackage-permissions-roles-rest
    port: 8080
    description: REST adapter for API Reference — subpackage_permissions.subpackage_permissions/roles. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/permissions/roles
      name: api-permissions-roles
      description: REST surface for api-permissions-roles.
      operations:
      - method: GET
        name: list
        description: List Roles
        call: polytomic-subpackage-permissions-subpackage-permissions-roles.list
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: create
        description: Create Role
        call: polytomic-subpackage-permissions-subpackage-permissions-roles.create
        with:
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/permissions/roles/{id}
      name: api-permissions-roles-id
      description: REST surface for api-permissions-roles-id.
      operations:
      - method: GET
        name: get
        description: Get Role
        call: polytomic-subpackage-permissions-subpackage-permissions-roles.get
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: update
        description: Update Role
        call: polytomic-subpackage-permissions-subpackage-permissions-roles.update
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: Delete Role
        call: polytomic-subpackage-permissions-subpackage-permissions-roles.delete
        with:
          id: rest.id
          Authorization: rest.Authorization
          X-Polytomic-Version: rest.X-Polytomic-Version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: polytomic-subpackage-permissions-subpackage-permissions-roles-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — subpackage_permissions.subpackage_permissions/roles. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: list-roles
      description: List Roles
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-permissions-subpackage-permissions-roles.list
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: create-role
      description: Create Role
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: polytomic-subpackage-permissions-subpackage-permissions-roles.create
      with:
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-role
      description: Get Role
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: polytomic-subpackage-permissions-subpackage-permissions-roles.get
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.
    - name: update-role
      description: Update Role
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: polytomic-subpackage-permissions-subpackage-permissions-roles.update
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-role
      description: Delete Role
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: polytomic-subpackage-permissions-subpackage-permissions-roles.delete
      with:
        id: tools.id
        Authorization: tools.Authorization
        X-Polytomic-Version: tools.X-Polytomic-Version
      outputParameters:
      - type: object
        mapping: $.