SigNoz — channels

naftiko: 1.0.0-alpha2
info:
  label: SigNoz — channels
  description: 'SigNoz — channels. 7 operations. Lead operation: List notification channels. Self-contained Naftiko capability
    covering one Signoz business surface.'
  tags:
  - Signoz
  - channels
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SIGNOZ_API_KEY: SIGNOZ_API_KEY
capability:
  consumes:
  - type: http
    namespace: signoz-channels
    baseUri: https://{host}:{port}{base_path}
    description: SigNoz — channels business capability. Self-contained, no shared references.
    resources:
    - name: api-v1-channels
      path: /api/v1/channels
      operations:
      - name: listchannels
        method: GET
        description: List notification channels
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createchannel
        method: POST
        description: Create notification channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v1-channels-test
      path: /api/v1/channels/test
      operations:
      - name: testchannel
        method: POST
        description: Test notification channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-v1-channels-id
      path: /api/v1/channels/{id}
      operations:
      - name: deletechannelbyid
        method: DELETE
        description: Delete notification channel
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: getchannelbyid
        method: GET
        description: Get notification channel by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
      - name: updatechannelbyid
        method: PUT
        description: Update notification channel
        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
    - name: api-v1-testChannel
      path: /api/v1/testChannel
      operations:
      - name: testchanneldeprecated
        method: POST
        description: Test notification channel (deprecated)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SIGNOZ_API_KEY}}'
  exposes:
  - type: rest
    namespace: signoz-channels-rest
    port: 8080
    description: REST adapter for SigNoz — channels. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/api/v1/channels
      name: api-v1-channels
      description: REST surface for api-v1-channels.
      operations:
      - method: GET
        name: listchannels
        description: List notification channels
        call: signoz-channels.listchannels
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createchannel
        description: Create notification channel
        call: signoz-channels.createchannel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/channels/test
      name: api-v1-channels-test
      description: REST surface for api-v1-channels-test.
      operations:
      - method: POST
        name: testchannel
        description: Test notification channel
        call: signoz-channels.testchannel
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/channels/{id}
      name: api-v1-channels-id
      description: REST surface for api-v1-channels-id.
      operations:
      - method: DELETE
        name: deletechannelbyid
        description: Delete notification channel
        call: signoz-channels.deletechannelbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getchannelbyid
        description: Get notification channel by ID
        call: signoz-channels.getchannelbyid
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatechannelbyid
        description: Update notification channel
        call: signoz-channels.updatechannelbyid
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v1/testchannel
      name: api-v1-testchannel
      description: REST surface for api-v1-testChannel.
      operations:
      - method: POST
        name: testchanneldeprecated
        description: Test notification channel (deprecated)
        call: signoz-channels.testchanneldeprecated
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: signoz-channels-mcp
    port: 9090
    transport: http
    description: MCP adapter for SigNoz — channels. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-notification-channels
      description: List notification channels
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: signoz-channels.listchannels
      outputParameters:
      - type: object
        mapping: $.
    - name: create-notification-channel
      description: Create notification channel
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: signoz-channels.createchannel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: test-notification-channel
      description: Test notification channel
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: signoz-channels.testchannel
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-notification-channel
      description: Delete notification channel
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: signoz-channels.deletechannelbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: get-notification-channel-id
      description: Get notification channel by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: signoz-channels.getchannelbyid
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-notification-channel
      description: Update notification channel
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: signoz-channels.updatechannelbyid
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: test-notification-channel-deprecated
      description: Test notification channel (deprecated)
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: signoz-channels.testchanneldeprecated
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.