NextGen Catalog API — Announcements

naftiko: 1.0.0-alpha2
info:
  label: NextGen Catalog API — Announcements
  description: 'NextGen Catalog API — Announcements. 4 operations. Lead operation: Get a list of announcements.. Self-contained
    Naftiko capability covering one National Archives And Records Administration business surface.'
  tags:
  - National Archives And Records Administration
  - Announcements
  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-announcements
    baseUri: https://catalog.archives.gov/api/v2
    description: NextGen Catalog API — Announcements business capability. Self-contained, no shared references.
    resources:
    - name: announcements
      path: /announcements
      operations:
      - name: get
        method: GET
        description: Get a list of announcements.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
          description: The page number of announcements to retrieve.
        - name: limit
          in: query
          type: integer
          description: The number of announcements to display per page.
        - name: status
          in: query
          type: string
          description: The status of the announcements to filter by.
        - name: sortCol
          in: query
          type: string
          description: The column to sort the announcements by.
        - name: sortOrder
          in: query
          type: string
          description: The order of sorting (ascending or descending).
      - name: post
        method: POST
        description: Create a new announcement.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: announcements-latest
      path: /announcements/latest
      operations:
      - name: get
        method: GET
        description: Get a list of active announcements.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: announcements-announcement_id
      path: /announcements/{announcement_id}
      operations:
      - name: put
        method: PUT
        description: Update an existing announcement.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: announcement_id
          in: path
          type: integer
          description: The unique identifier of the announcement to update.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: national-archives-and-records-administration-announcements-rest
    port: 8080
    description: REST adapter for NextGen Catalog API — Announcements. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/announcements
      name: announcements
      description: REST surface for announcements.
      operations:
      - method: GET
        name: get
        description: Get a list of announcements.
        call: national-archives-and-records-administration-announcements.get
        with:
          page: rest.page
          limit: rest.limit
          status: rest.status
          sortCol: rest.sortCol
          sortOrder: rest.sortOrder
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a new announcement.
        call: national-archives-and-records-administration-announcements.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/announcements/latest
      name: announcements-latest
      description: REST surface for announcements-latest.
      operations:
      - method: GET
        name: get
        description: Get a list of active announcements.
        call: national-archives-and-records-administration-announcements.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/announcements/{announcement-id}
      name: announcements-announcement-id
      description: REST surface for announcements-announcement_id.
      operations:
      - method: PUT
        name: put
        description: Update an existing announcement.
        call: national-archives-and-records-administration-announcements.put
        with:
          announcement_id: rest.announcement_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: national-archives-and-records-administration-announcements-mcp
    port: 9090
    transport: http
    description: MCP adapter for NextGen Catalog API — Announcements. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-list-announcements
      description: Get a list of announcements.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-announcements.get
      with:
        page: tools.page
        limit: tools.limit
        status: tools.status
        sortCol: tools.sortCol
        sortOrder: tools.sortOrder
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-announcement
      description: Create a new announcement.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: national-archives-and-records-administration-announcements.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-list-active-announcements
      description: Get a list of active announcements.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-announcements.get
      outputParameters:
      - type: object
        mapping: $.
    - name: update-existing-announcement
      description: Update an existing announcement.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: national-archives-and-records-administration-announcements.put
      with:
        announcement_id: tools.announcement_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.