Agreement Management — agreementSpecification

naftiko: 1.0.0-alpha2
info:
  label: Agreement Management — agreementSpecification
  description: 'Agreement Management — agreementSpecification. 5 operations. Lead operation: List or find AgreementSpecification
    objects. Self-contained Naftiko capability covering one Tm Forum business surface.'
  tags:
  - Tm Forum
  - agreementSpecification
  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: tmf651-agreement-management-agreementspecification
    baseUri: https://serverRoot/tmf-api/agreementManagement/v4
    description: Agreement Management — agreementSpecification business capability. Self-contained, no shared references.
    resources:
    - name: agreementSpecification
      path: /agreementSpecification
      operations:
      - name: listagreementspecification
        method: GET
        description: List or find AgreementSpecification 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: createagreementspecification
        method: POST
        description: Creates a AgreementSpecification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: agreementSpecification
          in: body
          type: string
          description: The AgreementSpecification to be created
          required: true
    - name: agreementSpecification-id
      path: /agreementSpecification/{id}
      operations:
      - name: retrieveagreementspecification
        method: GET
        description: Retrieves a AgreementSpecification by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the AgreementSpecification
          required: true
        - name: fields
          in: query
          type: string
          description: Comma-separated properties to provide in response
      - name: patchagreementspecification
        method: PATCH
        description: Updates partially a AgreementSpecification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the AgreementSpecification
          required: true
        - name: agreementSpecification
          in: body
          type: string
          description: The AgreementSpecification to be updated
          required: true
      - name: deleteagreementspecification
        method: DELETE
        description: Deletes a AgreementSpecification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Identifier of the AgreementSpecification
          required: true
  exposes:
  - type: rest
    namespace: tmf651-agreement-management-agreementspecification-rest
    port: 8080
    description: REST adapter for Agreement Management — agreementSpecification. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/agreementspecification
      name: agreementspecification
      description: REST surface for agreementSpecification.
      operations:
      - method: GET
        name: listagreementspecification
        description: List or find AgreementSpecification objects
        call: tmf651-agreement-management-agreementspecification.listagreementspecification
        with:
          fields: rest.fields
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createagreementspecification
        description: Creates a AgreementSpecification
        call: tmf651-agreement-management-agreementspecification.createagreementspecification
        with:
          agreementSpecification: rest.agreementSpecification
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/agreementspecification/{id}
      name: agreementspecification-id
      description: REST surface for agreementSpecification-id.
      operations:
      - method: GET
        name: retrieveagreementspecification
        description: Retrieves a AgreementSpecification by ID
        call: tmf651-agreement-management-agreementspecification.retrieveagreementspecification
        with:
          id: rest.id
          fields: rest.fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: patchagreementspecification
        description: Updates partially a AgreementSpecification
        call: tmf651-agreement-management-agreementspecification.patchagreementspecification
        with:
          id: rest.id
          agreementSpecification: rest.agreementSpecification
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteagreementspecification
        description: Deletes a AgreementSpecification
        call: tmf651-agreement-management-agreementspecification.deleteagreementspecification
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tmf651-agreement-management-agreementspecification-mcp
    port: 9090
    transport: http
    description: MCP adapter for Agreement Management — agreementSpecification. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-find-agreementspecification-objects
      description: List or find AgreementSpecification objects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf651-agreement-management-agreementspecification.listagreementspecification
      with:
        fields: tools.fields
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-agreementspecification
      description: Creates a AgreementSpecification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tmf651-agreement-management-agreementspecification.createagreementspecification
      with:
        agreementSpecification: tools.agreementSpecification
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-agreementspecification-id
      description: Retrieves a AgreementSpecification by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tmf651-agreement-management-agreementspecification.retrieveagreementspecification
      with:
        id: tools.id
        fields: tools.fields
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-partially-agreementspecification
      description: Updates partially a AgreementSpecification
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: tmf651-agreement-management-agreementspecification.patchagreementspecification
      with:
        id: tools.id
        agreementSpecification: tools.agreementSpecification
      outputParameters:
      - type: object
        mapping: $.
    - name: deletes-agreementspecification
      description: Deletes a AgreementSpecification
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tmf651-agreement-management-agreementspecification.deleteagreementspecification
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.