Resource Catalog Management — resourceCandidate

naftiko: 1.0.0-alpha2
info:
  label: Resource Catalog Management — resourceCandidate
  description: 'Resource Catalog Management — resourceCandidate. 5 operations. Lead operation: List or find ResourceCandidate
    objects. Self-contained Naftiko capability covering one Tm Forum business surface.'
  tags:
  - Tm Forum
  - resourceCandidate
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TM_FORUM_API_KEY: TM_FORUM_API_KEY
capability:
  consumes:
  - type: http
    namespace: tmf634-resource-catalog-resourcecandidate
    baseUri: https://serverRoot/tmf-api/resourceCatalog/v4
    description: Resource Catalog Management — resourceCandidate business capability. Self-contained, no shared references.
    resources:
    - name: resourceCandidate
      path: /resourceCandidate
      operations:
      - name: listresourcecandidate
        method: GET
        description: List or find ResourceCandidate objects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to be provided in response
        - name: offset
          in: query
          type: integer
          description: Requested index for start of resources to be provided in response
        - name: limit
          in: query
          type: integer
          description: Requested number of resources to be provided in response
      - name: createresourcecandidate
        method: POST
        description: Creates a ResourceCandidate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: resourceCandidate
          in: body
          type: string
          description: The ResourceCandidate to be created
          required: true
    - name: resourceCandidate-id
      path: /resourceCandidate/{id}
      operations:
      - name: retrieveresourcecandidate
        method: GET
        description: Retrieves a ResourceCandidate by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the ResourceCandidate
          required: true
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to provide in response
      - name: patchresourcecandidate
        method: PATCH
        description: Updates partially a ResourceCandidate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the ResourceCandidate
          required: true
        - name: resourceCandidate
          in: body
          type: string
          description: The ResourceCandidate to be updated
          required: true
      - name: deleteresourcecandidate
        method: DELETE
        description: Deletes a ResourceCandidate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the ResourceCandidate
          required: true
  exposes:
  - type: rest
    namespace: tmf634-resource-catalog-resourcecandidate-rest
    port: 8080
    description: REST adapter for Resource Catalog Management — resourceCandidate. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/resourcecandidate
      name: resourcecandidate
      description: REST surface for resourceCandidate.
      operations:
      - method: GET
        name: listresourcecandidate
        description: List or find ResourceCandidate objects
        call: tmf634-resource-catalog-resourcecandidate.listresourcecandidate
        with:
          fields: rest.fields
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createresourcecandidate
        description: Creates a ResourceCandidate
        call: tmf634-resource-catalog-resourcecandidate.createresourcecandidate
        with:
          resourceCandidate: rest.resourceCandidate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/resourcecandidate/{id}
      name: resourcecandidate-id
      description: REST surface for resourceCandidate-id.
      operations:
      - method: GET
        name: retrieveresourcecandidate
        description: Retrieves a ResourceCandidate by ID
        call: tmf634-resource-catalog-resourcecandidate.retrieveresourcecandidate
        with:
          id: rest.id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchresourcecandidate
        description: Updates partially a ResourceCandidate
        call: tmf634-resource-catalog-resourcecandidate.patchresourcecandidate
        with:
          id: rest.id
          resourceCandidate: rest.resourceCandidate
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteresourcecandidate
        description: Deletes a ResourceCandidate
        call: tmf634-resource-catalog-resourcecandidate.deleteresourcecandidate
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tmf634-resource-catalog-resourcecandidate-mcp
    port: 9090
    transport: http
    description: MCP adapter for Resource Catalog Management — resourceCandidate. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-find-resourcecandidate-objects
      description: List or find ResourceCandidate objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf634-resource-catalog-resourcecandidate.listresourcecandidate
      with:
        fields: tools.fields
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-resourcecandidate
      description: Creates a ResourceCandidate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tmf634-resource-catalog-resourcecandidate.createresourcecandidate
      with:
        resourceCandidate: tools.resourceCandidate
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-resourcecandidate-id
      description: Retrieves a ResourceCandidate by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf634-resource-catalog-resourcecandidate.retrieveresourcecandidate
      with:
        id: tools.id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-partially-resourcecandidate
      description: Updates partially a ResourceCandidate
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tmf634-resource-catalog-resourcecandidate.patchresourcecandidate
      with:
        id: tools.id
        resourceCandidate: tools.resourceCandidate
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-resourcecandidate
      description: Deletes a ResourceCandidate
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tmf634-resource-catalog-resourcecandidate.deleteresourcecandidate
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.