Checkmarx SCA API — Settings

naftiko: 1.0.0-alpha2
info:
  label: Checkmarx SCA API — Settings
  description: 'Checkmarx SCA API — Settings. 2 operations. Lead operation: Checkmarx Get project settings. Self-contained
    Naftiko capability covering one Checkmarx business surface.'
  tags:
  - Checkmarx
  - Settings
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CHECKMARX_API_KEY: CHECKMARX_API_KEY
capability:
  consumes:
  - type: http
    namespace: sca-settings
    baseUri: https://api-sca.checkmarx.net
    description: Checkmarx SCA API — Settings business capability. Self-contained, no shared references.
    resources:
    - name: settings-projects-projectId
      path: /settings/projects/{projectId}
      operations:
      - name: getprojectsettings
        method: GET
        description: Checkmarx Get project settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateprojectsettings
        method: PUT
        description: Checkmarx Update project settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.CHECKMARX_API_KEY}}'
  exposes:
  - type: rest
    namespace: sca-settings-rest
    port: 8080
    description: REST adapter for Checkmarx SCA API — Settings. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/settings/projects/{projectid}
      name: settings-projects-projectid
      description: REST surface for settings-projects-projectId.
      operations:
      - method: GET
        name: getprojectsettings
        description: Checkmarx Get project settings
        call: sca-settings.getprojectsettings
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateprojectsettings
        description: Checkmarx Update project settings
        call: sca-settings.updateprojectsettings
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sca-settings-mcp
    port: 9090
    transport: http
    description: MCP adapter for Checkmarx SCA API — Settings. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: checkmarx-get-project-settings
      description: Checkmarx Get project settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sca-settings.getprojectsettings
      outputParameters:
      - type: object
        mapping: $.
    - name: checkmarx-update-project-settings
      description: Checkmarx Update project settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sca-settings.updateprojectsettings
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.