NextGen Catalog API — Partner

naftiko: 1.0.0-alpha2
info:
  label: NextGen Catalog API — Partner
  description: 'NextGen Catalog API — Partner. 5 operations. Lead operation: Get partner contributions by fullName.. Self-contained
    Naftiko capability covering one National Archives And Records Administration business surface.'
  tags:
  - National Archives And Records Administration
  - Partner
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NATIONAL_ARCHIVES_AND_RECORDS_ADMINISTRATION_API_KEY: NATIONAL_ARCHIVES_AND_RECORDS_ADMINISTRATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: national-archives-and-records-administration-partner
    baseUri: https://catalog.archives.gov/api/v2
    description: NextGen Catalog API — Partner business capability. Self-contained, no shared references.
    resources:
    - name: partners-contributions-fullName-fullName
      path: /partners/contributions/fullName/{fullName}
      operations:
      - name: get
        method: GET
        description: Get partner contributions by fullName.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: fullName
          in: path
          type: string
          description: The fullName of the partner.
          required: true
    - name: partners-contributions-partnerNameId-partnerNameId
      path: /partners/contributions/partnerNameId/{partnerNameId}
      operations:
      - name: get
        method: GET
        description: Get partner contributions by partnerNameId.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: partnerNameId
          in: path
          type: string
          description: The unique identifier of the partner.
          required: true
    - name: partners-create
      path: /partners/create
      operations:
      - name: post
        method: POST
        description: Create a new partner.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: partners-search
      path: /partners/search
      operations:
      - name: get
        method: GET
        description: Search for partners
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: partnerNameId
          in: query
          type: string
          description: partnerNameId of the partner being searched
        - name: fullName
          in: query
          type: string
          description: Full name of the partner being searched
        - name: userId
          in: query
          type: string
          description: userId of the user that associated with the partner
    - name: partners-update
      path: /partners/update
      operations:
      - name: patch
        method: PATCH
        description: Update partner name.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: national-archives-and-records-administration-partner-rest
    port: 8080
    description: REST adapter for NextGen Catalog API — Partner. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/partners/contributions/fullname/{fullname}
      name: partners-contributions-fullname-fullname
      description: REST surface for partners-contributions-fullName-fullName.
      operations:
      - method: GET
        name: get
        description: Get partner contributions by fullName.
        call: national-archives-and-records-administration-partner.get
        with:
          fullName: rest.fullName
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/partners/contributions/partnernameid/{partnernameid}
      name: partners-contributions-partnernameid-partnernameid
      description: REST surface for partners-contributions-partnerNameId-partnerNameId.
      operations:
      - method: GET
        name: get
        description: Get partner contributions by partnerNameId.
        call: national-archives-and-records-administration-partner.get
        with:
          partnerNameId: rest.partnerNameId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/partners/create
      name: partners-create
      description: REST surface for partners-create.
      operations:
      - method: POST
        name: post
        description: Create a new partner.
        call: national-archives-and-records-administration-partner.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/partners/search
      name: partners-search
      description: REST surface for partners-search.
      operations:
      - method: GET
        name: get
        description: Search for partners
        call: national-archives-and-records-administration-partner.get
        with:
          partnerNameId: rest.partnerNameId
          fullName: rest.fullName
          userId: rest.userId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/partners/update
      name: partners-update
      description: REST surface for partners-update.
      operations:
      - method: PATCH
        name: patch
        description: Update partner name.
        call: national-archives-and-records-administration-partner.patch
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-archives-and-records-administration-partner-mcp
    port: 9090
    transport: http
    description: MCP adapter for NextGen Catalog API — Partner. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-partner-contributions-fullname
      description: Get partner contributions by fullName.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-partner.get
      with:
        fullName: tools.fullName
      outputParameters:
      - type: object
        mapping: $.
    - name: get-partner-contributions-partnernameid
      description: Get partner contributions by partnerNameId.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-partner.get
      with:
        partnerNameId: tools.partnerNameId
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-partner
      description: Create a new partner.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: national-archives-and-records-administration-partner.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: search-partners
      description: Search for partners
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-partner.get
      with:
        partnerNameId: tools.partnerNameId
        fullName: tools.fullName
        userId: tools.userId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-partner-name
      description: Update partner name.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-partner.patch
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.