Microcks API v1.14 — job

naftiko: 1.0.0-alpha2
info:
  label: Microcks API v1.14 — job
  description: 'Microcks API v1.14 — job. 11 operations. Lead operation: Download an artifact. Self-contained Naftiko capability
    covering one Microcks business surface.'
  tags:
  - Microcks
  - job
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROCKS_API_KEY: MICROCKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: microcks-job
    baseUri: http://microcks.example.com/api
    description: Microcks API v1.14 — job business capability. Self-contained, no shared references.
    resources:
    - name: artifact-download
      path: /artifact/download
      operations:
      - name: downloadartifact
        method: POST
        description: Download an artifact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: artifact-upload
      path: /artifact/upload
      operations:
      - name: uploadartifact
        method: POST
        description: Upload an artifact
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: mainArtifact
          in: query
          type: boolean
          description: Flag telling if this should be considered as primary or secondary artifact. Default to 'true'
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: jobs
      path: /jobs
      operations:
      - name: getimportjobs
        method: GET
        description: Get ImportJobs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: Page of ImportJobs to retrieve (starts at and defaults to 0)
        - name: size
          in: query
          type: integer
          description: Size of a page. Maximum number of ImportJobs to include in a response (defaults to 20)
        - name: name
          in: query
          type: string
          description: Name like criterion for query
      - name: createimportjob
        method: POST
        description: Create ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: jobs-count
      path: /jobs/count
      operations:
      - name: getimportjobcounter
        method: GET
        description: Get the ImportJobs counter
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs-id
      path: /jobs/{id}
      operations:
      - name: getimportjob
        method: GET
        description: Get ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateimportjob
        method: POST
        description: Update ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteimportjob
        method: DELETE
        description: Delete ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs-id-activate
      path: /jobs/{id}/activate
      operations:
      - name: activateimportjob
        method: PUT
        description: Activate an ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs-id-start
      path: /jobs/{id}/start
      operations:
      - name: startimportjob
        method: PUT
        description: Start an ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: jobs-id-stop
      path: /jobs/{id}/stop
      operations:
      - name: stopimportjob
        method: PUT
        description: Stop an ImportJob
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.MICROCKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: microcks-job-rest
    port: 8080
    description: REST adapter for Microcks API v1.14 — job. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/artifact/download
      name: artifact-download
      description: REST surface for artifact-download.
      operations:
      - method: POST
        name: downloadartifact
        description: Download an artifact
        call: microcks-job.downloadartifact
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/artifact/upload
      name: artifact-upload
      description: REST surface for artifact-upload.
      operations:
      - method: POST
        name: uploadartifact
        description: Upload an artifact
        call: microcks-job.uploadartifact
        with:
          mainArtifact: rest.mainArtifact
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs
      name: jobs
      description: REST surface for jobs.
      operations:
      - method: GET
        name: getimportjobs
        description: Get ImportJobs
        call: microcks-job.getimportjobs
        with:
          page: rest.page
          size: rest.size
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createimportjob
        description: Create ImportJob
        call: microcks-job.createimportjob
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/count
      name: jobs-count
      description: REST surface for jobs-count.
      operations:
      - method: GET
        name: getimportjobcounter
        description: Get the ImportJobs counter
        call: microcks-job.getimportjobcounter
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{id}
      name: jobs-id
      description: REST surface for jobs-id.
      operations:
      - method: GET
        name: getimportjob
        description: Get ImportJob
        call: microcks-job.getimportjob
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateimportjob
        description: Update ImportJob
        call: microcks-job.updateimportjob
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteimportjob
        description: Delete ImportJob
        call: microcks-job.deleteimportjob
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{id}/activate
      name: jobs-id-activate
      description: REST surface for jobs-id-activate.
      operations:
      - method: PUT
        name: activateimportjob
        description: Activate an ImportJob
        call: microcks-job.activateimportjob
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{id}/start
      name: jobs-id-start
      description: REST surface for jobs-id-start.
      operations:
      - method: PUT
        name: startimportjob
        description: Start an ImportJob
        call: microcks-job.startimportjob
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/jobs/{id}/stop
      name: jobs-id-stop
      description: REST surface for jobs-id-stop.
      operations:
      - method: PUT
        name: stopimportjob
        description: Stop an ImportJob
        call: microcks-job.stopimportjob
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: microcks-job-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microcks API v1.14 — job. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: download-artifact
      description: Download an artifact
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microcks-job.downloadartifact
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: upload-artifact
      description: Upload an artifact
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microcks-job.uploadartifact
      with:
        mainArtifact: tools.mainArtifact
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-importjobs
      description: Get ImportJobs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microcks-job.getimportjobs
      with:
        page: tools.page
        size: tools.size
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: create-importjob
      description: Create ImportJob
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microcks-job.createimportjob
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-importjobs-counter
      description: Get the ImportJobs counter
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microcks-job.getimportjobcounter
      outputParameters:
      - type: object
        mapping: $.
    - name: get-importjob
      description: Get ImportJob
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: microcks-job.getimportjob
      outputParameters:
      - type: object
        mapping: $.
    - name: update-importjob
      description: Update ImportJob
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: microcks-job.updateimportjob
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-importjob
      description: Delete ImportJob
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: microcks-job.deleteimportjob
      outputParameters:
      - type: object
        mapping: $.
    - name: activate-importjob
      description: Activate an ImportJob
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: microcks-job.activateimportjob
      outputParameters:
      - type: object
        mapping: $.
    - name: start-importjob
      description: Start an ImportJob
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: microcks-job.startimportjob
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-importjob
      description: Stop an ImportJob
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: microcks-job.stopimportjob
      outputParameters:
      - type: object
        mapping: $.