Northflank API — Jobs

naftiko: 1.0.0-alpha2
info:
  label: Northflank API — Jobs
  description: 'Northflank API — Jobs. 3 operations. Lead operation: List jobs in a project. Self-contained Naftiko capability
    covering one Northflank business surface.'
  tags:
  - Northflank
  - Jobs
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NORTHFLANK_API_KEY: NORTHFLANK_API_KEY
capability:
  consumes:
  - type: http
    namespace: northflank-jobs
    baseUri: https://api.northflank.com/v1
    description: Northflank API — Jobs business capability. Self-contained, no shared references.
    resources:
    - name: projects-projectId-jobs
      path: /projects/{projectId}/jobs
      operations:
      - name: listjobs
        method: GET
        description: List jobs in a project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createjob
        method: POST
        description: Create a job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: projects-projectId-jobs-jobId-run
      path: /projects/{projectId}/jobs/{jobId}/run
      operations:
      - name: runjob
        method: POST
        description: Run a job
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: jobId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.NORTHFLANK_API_KEY}}'
  exposes:
  - type: rest
    namespace: northflank-jobs-rest
    port: 8080
    description: REST adapter for Northflank API — Jobs. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/projects/{projectid}/jobs
      name: projects-projectid-jobs
      description: REST surface for projects-projectId-jobs.
      operations:
      - method: GET
        name: listjobs
        description: List jobs in a project
        call: northflank-jobs.listjobs
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createjob
        description: Create a job
        call: northflank-jobs.createjob
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/projects/{projectid}/jobs/{jobid}/run
      name: projects-projectid-jobs-jobid-run
      description: REST surface for projects-projectId-jobs-jobId-run.
      operations:
      - method: POST
        name: runjob
        description: Run a job
        call: northflank-jobs.runjob
        with:
          jobId: rest.jobId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: northflank-jobs-mcp
    port: 9090
    transport: http
    description: MCP adapter for Northflank API — Jobs. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-jobs-project
      description: List jobs in a project
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: northflank-jobs.listjobs
      outputParameters:
      - type: object
        mapping: $.
    - name: create-job
      description: Create a job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: northflank-jobs.createjob
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: run-job
      description: Run a job
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: northflank-jobs.runjob
      with:
        jobId: tools.jobId
      outputParameters:
      - type: object
        mapping: $.