Sonatype Lifecycle Public REST API — CPE Matching Configuration

naftiko: 1.0.0-alpha2
info:
  label: Sonatype Lifecycle Public REST API — CPE Matching Configuration
  description: 'Sonatype Lifecycle Public REST API — CPE Matching Configuration. 2 operations. Lead operation: CPE Matching
    Configuration. Self-contained Naftiko capability covering one Sonatype business surface.'
  tags:
  - Sonatype
  - CPE Matching Configuration
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SONATYPE_API_KEY: SONATYPE_API_KEY
capability:
  consumes:
  - type: http
    namespace: lifecycle-cpe-matching-configuration
    baseUri: ''
    description: Sonatype Lifecycle Public REST API — CPE Matching Configuration business capability. Self-contained, no shared
      references.
    resources:
    - name: api-v2-ownerType-internalOwnerId-configuration-publicSource-cpe
      path: /api/v2/{ownerType}/{internalOwnerId}/configuration/publicSource/cpe
      operations:
      - name: getcpematchingconfiguration
        method: GET
        description: 'This method allows to retrieve the applicable cpe matching configuration of a given organization or
          application.<p>Permissions Required: View IQ Elements'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ownerType
          in: path
          type: string
          required: true
        - name: internalOwnerId
          in: path
          type: string
          required: true
      - name: updatecpematchingconfiguration
        method: PUT
        description: 'Use this method to apply a given cpe matching configuration to an organization or application.<p>Permissions
          Required: Edit IQ Elements'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ownerType
          in: path
          type: string
          required: true
        - name: internalOwnerId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.SONATYPE_API_KEY}}'
  exposes:
  - type: rest
    namespace: lifecycle-cpe-matching-configuration-rest
    port: 8080
    description: REST adapter for Sonatype Lifecycle Public REST API — CPE Matching Configuration. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/api/v2/{ownertype}/{internalownerid}/configuration/publicsource/cpe
      name: api-v2-ownertype-internalownerid-configuration-publicsource-cpe
      description: REST surface for api-v2-ownerType-internalOwnerId-configuration-publicSource-cpe.
      operations:
      - method: GET
        name: getcpematchingconfiguration
        description: 'This method allows to retrieve the applicable cpe matching configuration of a given organization or
          application.<p>Permissions Required: View IQ Elements'
        call: lifecycle-cpe-matching-configuration.getcpematchingconfiguration
        with:
          ownerType: rest.ownerType
          internalOwnerId: rest.internalOwnerId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecpematchingconfiguration
        description: 'Use this method to apply a given cpe matching configuration to an organization or application.<p>Permissions
          Required: Edit IQ Elements'
        call: lifecycle-cpe-matching-configuration.updatecpematchingconfiguration
        with:
          ownerType: rest.ownerType
          internalOwnerId: rest.internalOwnerId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: lifecycle-cpe-matching-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sonatype Lifecycle Public REST API — CPE Matching Configuration. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: this-method-allows-retrieve-applicable
      description: 'This method allows to retrieve the applicable cpe matching configuration of a given organization or application.<p>Permissions
        Required: View IQ Elements'
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: lifecycle-cpe-matching-configuration.getcpematchingconfiguration
      with:
        ownerType: tools.ownerType
        internalOwnerId: tools.internalOwnerId
      outputParameters:
      - type: object
        mapping: $.
    - name: use-this-method-apply-given
      description: 'Use this method to apply a given cpe matching configuration to an organization or application.<p>Permissions
        Required: Edit IQ Elements'
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: lifecycle-cpe-matching-configuration.updatecpematchingconfiguration
      with:
        ownerType: tools.ownerType
        internalOwnerId: tools.internalOwnerId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.