API Reference — SecretService

naftiko: 1.0.0-alpha2
info:
  label: API Reference — SecretService
  description: 'API Reference — SecretService. 3 operations. Lead operation: SecretService. Self-contained Naftiko capability
    covering one Stackrox business surface.'
  tags:
  - Stackrox
  - SecretService
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    STACKROX_API_KEY: STACKROX_API_KEY
capability:
  consumes:
  - type: http
    namespace: stackrox-secretservice
    baseUri: https://{central-host}
    description: API Reference — SecretService business capability. Self-contained, no shared references.
    resources:
    - name: v1-secrets
      path: /v1/secrets
      operations:
      - name: listsecrets
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
    - name: v1-secrets-id
      path: /v1/secrets/{id}
      operations:
      - name: getsecret
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    - name: v1-secretscount
      path: /v1/secretscount
      operations:
      - name: countsecrets
        method: GET
        description: ''
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: query
          in: query
          type: string
        - name: pagination.limit
          in: query
          type: integer
        - name: pagination.offset
          in: query
          type: integer
        - name: pagination.sort_option.field
          in: query
          type: string
        - name: pagination.sort_option.reversed
          in: query
          type: boolean
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.STACKROX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: stackrox-secretservice-rest
    port: 8080
    description: REST adapter for API Reference — SecretService. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/secrets
      name: v1-secrets
      description: REST surface for v1-secrets.
      operations:
      - method: GET
        name: listsecrets
        description: listsecrets
        call: stackrox-secretservice.listsecrets
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/secrets/{id}
      name: v1-secrets-id
      description: REST surface for v1-secrets-id.
      operations:
      - method: GET
        name: getsecret
        description: getsecret
        call: stackrox-secretservice.getsecret
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/secretscount
      name: v1-secretscount
      description: REST surface for v1-secretscount.
      operations:
      - method: GET
        name: countsecrets
        description: countsecrets
        call: stackrox-secretservice.countsecrets
        with:
          query: rest.query
          pagination.limit: rest.pagination.limit
          pagination.offset: rest.pagination.offset
          pagination.sort_option.field: rest.pagination.sort_option.field
          pagination.sort_option.reversed: rest.pagination.sort_option.reversed
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: stackrox-secretservice-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — SecretService. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: listsecrets
      description: listsecrets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-secretservice.listsecrets
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.
    - name: getsecret
      description: getsecret
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-secretservice.getsecret
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: countsecrets
      description: countsecrets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: stackrox-secretservice.countsecrets
      with:
        query: tools.query
        pagination.limit: tools.pagination.limit
        pagination.offset: tools.pagination.offset
        pagination.sort_option.field: tools.pagination.sort_option.field
        pagination.sort_option.reversed: tools.pagination.sort_option.reversed
      outputParameters:
      - type: object
        mapping: $.