Permit.io API — Projects

naftiko: 1.0.0-alpha2
info:
  label: Permit.io API — Projects
  description: 'Permit.io API — Projects. 5 operations. Lead operation: List Projects. Self-contained Naftiko capability covering
    one Permit Io business surface.'
  tags:
  - Permit Io
  - Projects
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PERMIT_IO_API_KEY: PERMIT_IO_API_KEY
capability:
  consumes:
  - type: http
    namespace: permit-io-projects
    baseUri: ''
    description: Permit.io API — Projects business capability. Self-contained, no shared references.
    resources:
    - name: v2-projects
      path: /v2/projects
      operations:
      - name: listprojects
        method: GET
        description: List Projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page number of the results to fetch, starting at 1.
        - name: per_page
          in: query
          type: integer
          description: The number of results per page (max 100).
      - name: createproject
        method: POST
        description: Create Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v2-projects-proj_id
      path: /v2/projects/{proj_id}
      operations:
      - name: getproject
        method: GET
        description: Get Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: proj_id
          in: path
          type: string
          description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
          required: true
      - name: deleteproject
        method: DELETE
        description: Delete Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: proj_id
          in: path
          type: string
          description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
          required: true
      - name: updateproject
        method: PATCH
        description: Update Project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: proj_id
          in: path
          type: string
          description: 'Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.PERMIT_IO_API_KEY}}'
  exposes:
  - type: rest
    namespace: permit-io-projects-rest
    port: 8080
    description: REST adapter for Permit.io API — Projects. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v2/projects
      name: v2-projects
      description: REST surface for v2-projects.
      operations:
      - method: GET
        name: listprojects
        description: List Projects
        call: permit-io-projects.listprojects
        with:
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproject
        description: Create Project
        call: permit-io-projects.createproject
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/projects/{proj-id}
      name: v2-projects-proj-id
      description: REST surface for v2-projects-proj_id.
      operations:
      - method: GET
        name: getproject
        description: Get Project
        call: permit-io-projects.getproject
        with:
          proj_id: rest.proj_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteproject
        description: Delete Project
        call: permit-io-projects.deleteproject
        with:
          proj_id: rest.proj_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateproject
        description: Update Project
        call: permit-io-projects.updateproject
        with:
          proj_id: rest.proj_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: permit-io-projects-mcp
    port: 9090
    transport: http
    description: MCP adapter for Permit.io API — Projects. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-projects
      description: List Projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permit-io-projects.listprojects
      with:
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-project
      description: Create Project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: permit-io-projects.createproject
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-project
      description: Get Project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: permit-io-projects.getproject
      with:
        proj_id: tools.proj_id
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-project
      description: Delete Project
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: permit-io-projects.deleteproject
      with:
        proj_id: tools.proj_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-project
      description: Update Project
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: permit-io-projects.updateproject
      with:
        proj_id: tools.proj_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.