Ashby API — Assessment

naftiko: 1.0.0-alpha2
info:
  label: Ashby API — Assessment
  description: 'Ashby API — Assessment. 6 operations. Lead operation: assessment.addCompletedToCandidate. Self-contained Naftiko
    capability covering one Ashby business surface.'
  tags:
  - Ashby
  - Assessment
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ASHBY_API_KEY: ASHBY_API_KEY
capability:
  consumes:
  - type: http
    namespace: ashby-assessment
    baseUri: https://api.ashbyhq.com
    description: Ashby API — Assessment business capability. Self-contained, no shared references.
    resources:
    - name: assessment.addCompletedToCandidate
      path: /assessment.addCompletedToCandidate
      operations:
      - name: assessmentaddcompletedtocandidate
        method: POST
        description: assessment.addCompletedToCandidate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: assessment.cancel
      path: /assessment.cancel
      operations:
      - name: assessmentcancel
        method: POST
        description: assessment.cancel (Implemented by Partner)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: assessment.customField.list
      path: /assessment.customField.list
      operations:
      - name: assessmentpartnercustomfieldlist
        method: POST
        description: customField.list (Implemented by Partner)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: assessment.list
      path: /assessment.list
      operations:
      - name: assessmentlist
        method: POST
        description: assessment.list (Implemented by Partner)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: assessment.start
      path: /assessment.start
      operations:
      - name: assessmentstart
        method: POST
        description: assessment.start (Implemented by Partner)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: assessment.update
      path: /assessment.update
      operations:
      - name: assessmentupdate
        method: POST
        description: assessment.update
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Ashby-Signature
      value: '{{env.ASHBY_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: ashby-assessment-rest
    port: 8080
    description: REST adapter for Ashby API — Assessment. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/assessment-addcompletedtocandidate
      name: assessment-addcompletedtocandidate
      description: REST surface for assessment.addCompletedToCandidate.
      operations:
      - method: POST
        name: assessmentaddcompletedtocandidate
        description: assessment.addCompletedToCandidate
        call: ashby-assessment.assessmentaddcompletedtocandidate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assessment-cancel
      name: assessment-cancel
      description: REST surface for assessment.cancel.
      operations:
      - method: POST
        name: assessmentcancel
        description: assessment.cancel (Implemented by Partner)
        call: ashby-assessment.assessmentcancel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assessment-customfield-list
      name: assessment-customfield-list
      description: REST surface for assessment.customField.list.
      operations:
      - method: POST
        name: assessmentpartnercustomfieldlist
        description: customField.list (Implemented by Partner)
        call: ashby-assessment.assessmentpartnercustomfieldlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assessment-list
      name: assessment-list
      description: REST surface for assessment.list.
      operations:
      - method: POST
        name: assessmentlist
        description: assessment.list (Implemented by Partner)
        call: ashby-assessment.assessmentlist
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assessment-start
      name: assessment-start
      description: REST surface for assessment.start.
      operations:
      - method: POST
        name: assessmentstart
        description: assessment.start (Implemented by Partner)
        call: ashby-assessment.assessmentstart
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/assessment-update
      name: assessment-update
      description: REST surface for assessment.update.
      operations:
      - method: POST
        name: assessmentupdate
        description: assessment.update
        call: ashby-assessment.assessmentupdate
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ashby-assessment-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ashby API — Assessment. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: assessment-addcompletedtocandidate
      description: assessment.addCompletedToCandidate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ashby-assessment.assessmentaddcompletedtocandidate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: assessment-cancel-implemented-partner
      description: assessment.cancel (Implemented by Partner)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ashby-assessment.assessmentcancel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: customfield-list-implemented-partner
      description: customField.list (Implemented by Partner)
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ashby-assessment.assessmentpartnercustomfieldlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: assessment-list-implemented-partner
      description: assessment.list (Implemented by Partner)
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ashby-assessment.assessmentlist
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: assessment-start-implemented-partner
      description: assessment.start (Implemented by Partner)
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ashby-assessment.assessmentstart
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: assessment-update
      description: assessment.update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ashby-assessment.assessmentupdate
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.