API Reference — NotifierService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — NotifierService
  description: 'API Reference — NotifierService. 6 operations. Lead operation: NotifierService. Self-contained Naftiko capability
    covering one Stackrox business surface.'
  tags:
  - Stackrox
  - NotifierService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-notifierservice
    baseUri: https://{central-host}
    description: API Reference — NotifierService business capability. Self-contained, no shared references.
    resources:
    - name: v1-notifiers
      path: /v1/notifiers
      operations:
      - name: getnotifiers
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
        - name: type
          in: query
          type: string
      - name: postnotifier
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-notifiers-test
      path: /v1/notifiers/test
      operations:
      - name: testnotifier
        method: POST
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v1-notifiers-id
      path: /v1/notifiers/{id}
      operations:
      - name: getnotifier
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: deletenotifier
        method: DELETE
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: force
          in: query
          type: boolean
      - name: putnotifier
        method: PUT
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-notifierservice-rest
    port: 8080
    description: REST adapter for API Reference — NotifierService. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/notifiers
      name: v1-notifiers
      description: REST surface for v1-notifiers.
      operations:
      - method: GET
        name: getnotifiers
        description: getnotifiers
        call: stackrox-notifierservice.getnotifiers
        with:
          name: rest.name
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: postnotifier
        description: postnotifier
        call: stackrox-notifierservice.postnotifier
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notifiers/test
      name: v1-notifiers-test
      description: REST surface for v1-notifiers-test.
      operations:
      - method: POST
        name: testnotifier
        description: testnotifier
        call: stackrox-notifierservice.testnotifier
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/notifiers/{id}
      name: v1-notifiers-id
      description: REST surface for v1-notifiers-id.
      operations:
      - method: GET
        name: getnotifier
        description: getnotifier
        call: stackrox-notifierservice.getnotifier
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletenotifier
        description: deletenotifier
        call: stackrox-notifierservice.deletenotifier
        with:
          id: rest.id
          force: rest.force
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putnotifier
        description: putnotifier
        call: stackrox-notifierservice.putnotifier
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-notifierservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — NotifierService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: getnotifiers
      description: getnotifiers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-notifierservice.getnotifiers
      with:
        name: tools.name
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: postnotifier
      description: postnotifier
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-notifierservice.postnotifier
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: testnotifier
      description: testnotifier
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: stackrox-notifierservice.testnotifier
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: getnotifier
      description: getnotifier
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-notifierservice.getnotifier
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: deletenotifier
      description: deletenotifier
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: stackrox-notifierservice.deletenotifier
      with:
        id: tools.id
        force: tools.force
      outputParameters:
      - type: object
        mapping: $.
    - name: putnotifier
      description: putnotifier
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: stackrox-notifierservice.putnotifier
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.