NAIC

NAIC Block Content API

Reusable content blocks used to compose NAIC pages.

GitHub OpenAPI

Operations 22

GET /block_content/basic List block_content / basic resources #
GET /block_content/basic/{id} Get one block_content / basic resource by UUID #
GET /block_content/footer_content List block_content / footer_content resources #
GET /block_content/footer_content/{id} Get one block_content / footer_content resource by UUID #
GET /block_content/footer_menus List block_content / footer_menus resources #
GET /block_content/footer_menus/{id} Get one block_content / footer_menus resource by UUID #
GET /block_content/in_page_navigation List block_content / in_page_navigation resources #
GET /block_content/in_page_navigation/{id} Get one block_content / in_page_navigation resource by UUID #
GET /block_content/mega_menu_image_title_and_descri List block_content / mega_menu_image_title_and_descri resources #
GET /block_content/mega_menu_image_title_and_descri/{id} Get one block_content / mega_menu_image_title_and_descri resource by UUID #
GET /block_content/mega_menu_title_with_description List block_content / mega_menu_title_with_description resources #
GET /block_content/mega_menu_title_with_description/{id} Get one block_content / mega_menu_title_with_description resource by UUID #
GET /block_content/reusable_links_dropdown List block_content / reusable_links_dropdown resources #
GET /block_content/reusable_links_dropdown/{id} Get one block_content / reusable_links_dropdown resource by UUID #
GET /block_content/section_title_with_secondary_nav List block_content / section_title_with_secondary_nav resources #
GET /block_content/section_title_with_secondary_nav/{id} Get one block_content / section_title_with_secondary_nav resource by UUID #
GET /block_content/table_of_contents List block_content / table_of_contents resources #
GET /block_content/table_of_contents/{id} Get one block_content / table_of_contents resource by UUID #

Documentation

📖
Documentation
https://jsonapi.org/format/1.1/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/naic/refs/heads/main/openapi/naic-block-content-api-openapi.yml

Other Resources

🔗
Examples
https://raw.githubusercontent.com/api-evangelist/naic/refs/heads/main/examples/_index.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/naic-block-content-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

naic-block-content-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: 'NAIC Content JSON: Block Content API'
  version: '1.1'
  summary: Anonymous read API over the NAIC's public regulatory content estate (content.naic.org), served as Drupal JSON:API.
  description: The National Association of Insurance Commissioners does not publish an OpenAPI description.
  contact:
    name: NAIC Web Post
    email: webpost@naic.org
    url: https://content.naic.org/contact
  termsOfService: https://content.naic.org/application/terms-conditions
  license:
    name: All content (c) 1991-2025 National Association of Insurance Commissioners. All rights reserved.
    url: https://content.naic.org/application/terms-conditions
  x-derived-by: API Evangelist enrichment pipeline
  x-derived-from: https://content.naic.org/jsonapi
  x-derived-on: '2026-07-25'
  x-publisher-provided: false
servers:
- url: https://content.naic.org/jsonapi
  description: Production JSON:API entry point (public, anonymous read).
security: []
tags:
- name: Block Content
  description: Reusable content blocks used to compose NAIC pages.
paths:
  /block_content/basic:
    get:
      operationId: listBlockContentBasic
      summary: List block_content / basic resources
      description: Returns a JSON:API collection document of `block_content--basic` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/basic/{id}:
    get:
      operationId: getBlockContentBasic
      summary: Get one block_content / basic resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--basic` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/footer_content:
    get:
      operationId: listBlockContentFooterContent
      summary: List block_content / footer_content resources
      description: Returns a JSON:API collection document of `block_content--footer_content` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/footer_content/{id}:
    get:
      operationId: getBlockContentFooterContent
      summary: Get one block_content / footer_content resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--footer_content` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/footer_menus:
    get:
      operationId: listBlockContentFooterMenus
      summary: List block_content / footer_menus resources
      description: Returns a JSON:API collection document of `block_content--footer_menus` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/footer_menus/{id}:
    get:
      operationId: getBlockContentFooterMenus
      summary: Get one block_content / footer_menus resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--footer_menus` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/in_page_navigation:
    get:
      operationId: listBlockContentInPageNavigation
      summary: List block_content / in_page_navigation resources
      description: Returns a JSON:API collection document of `block_content--in_page_navigation` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/in_page_navigation/{id}:
    get:
      operationId: getBlockContentInPageNavigation
      summary: Get one block_content / in_page_navigation resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--in_page_navigation` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_image_title_and_descri:
    get:
      operationId: listBlockContentMegaMenuImageTitleAndDescri
      summary: List block_content / mega_menu_image_title_and_descri resources
      description: Returns a JSON:API collection document of `block_content--mega_menu_image_title_and_descri` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_image_title_and_descri/{id}:
    get:
      operationId: getBlockContentMegaMenuImageTitleAndDescri
      summary: Get one block_content / mega_menu_image_title_and_descri resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--mega_menu_image_title_and_descri` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_label_with_quicklinks:
    get:
      operationId: listBlockContentMegaMenuLabelWithQuicklinks
      summary: List block_content / mega_menu_label_with_quicklinks resources
      description: Returns a JSON:API collection document of `block_content--mega_menu_label_with_quicklinks` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_label_with_quicklinks/{id}:
    get:
      operationId: getBlockContentMegaMenuLabelWithQuicklinks
      summary: Get one block_content / mega_menu_label_with_quicklinks resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--mega_menu_label_with_quicklinks` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_title_with_description:
    get:
      operationId: listBlockContentMegaMenuTitleWithDescription
      summary: List block_content / mega_menu_title_with_description resources
      description: Returns a JSON:API collection document of `block_content--mega_menu_title_with_description` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_title_with_description/{id}:
    get:
      operationId: getBlockContentMegaMenuTitleWithDescription
      summary: Get one block_content / mega_menu_title_with_description resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--mega_menu_title_with_description` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_title_with_link_list:
    get:
      operationId: listBlockContentMegaMenuTitleWithLinkList
      summary: List block_content / mega_menu_title_with_link_list resources
      description: Returns a JSON:API collection document of `block_content--mega_menu_title_with_link_list` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/mega_menu_title_with_link_list/{id}:
    get:
      operationId: getBlockContentMegaMenuTitleWithLinkList
      summary: Get one block_content / mega_menu_title_with_link_list resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--mega_menu_title_with_link_list` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/reusable_links_dropdown:
    get:
      operationId: listBlockContentReusableLinksDropdown
      summary: List block_content / reusable_links_dropdown resources
      description: Returns a JSON:API collection document of `block_content--reusable_links_dropdown` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/reusable_links_dropdown/{id}:
    get:
      operationId: getBlockContentReusableLinksDropdown
      summary: Get one block_content / reusable_links_dropdown resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--reusable_links_dropdown` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/section_title_with_secondary_nav:
    get:
      operationId: listBlockContentSectionTitleWithSecondaryNav
      summary: List block_content / section_title_with_secondary_nav resources
      description: Returns a JSON:API collection document of `block_content--section_title_with_secondary_nav` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/section_title_with_secondary_nav/{id}:
    get:
      operationId: getBlockContentSectionTitleWithSecondaryNav
      summary: Get one block_content / section_title_with_secondary_nav resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--section_title_with_secondary_nav` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/table_of_contents:
    get:
      operationId: listBlockContentTableOfContents
      summary: List block_content / table_of_contents resources
      description: Returns a JSON:API collection document of `block_content--table_of_contents` resource objects. Supports JSON:API sparse fieldsets, sorting, filtering, related-resource inclusion and offset pagination. Verified anonymously readable on 2026-07-25.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/pageLimit'
      - $ref: '#/components/parameters/pageOffset'
      - $ref: '#/components/parameters/sort'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: A JSON:API collection document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/CollectionDocument'
        '400':
          $ref: '#/components/responses/BadRequest'
        '404':
          $ref: '#/components/responses/NotFound'
  /block_content/table_of_contents/{id}:
    get:
      operationId: getBlockContentTableOfContents
      summary: Get one block_content / table_of_contents resource by UUID
      description: Returns a JSON:API individual document for a single `block_content--table_of_contents` resource, addressed by its Drupal UUID. Supports sparse fieldsets and related-resource inclusion.
      tags:
      - Block Content
      parameters:
      - $ref: '#/components/parameters/resourceId'
      - $ref: '#/components/parameters/include'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/resourceVersion'
      responses:
        '200':
          description: A JSON:API individual document.
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/IndividualDocument'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Relationship:
      type: object
      properties:
        data:
          oneOf:
          - $ref: '#/components/schemas/ResourceIdentifier'
          - type: array
            items:
              $ref: '#/components/schemas/ResourceIdentifier'
          - type: 'null'
        links:
          $ref: '#/components/schemas/Links'
    ErrorDocument:
      type: object
      required:
      - errors
      description: JSON:API error document. The NAIC surface returns JSON:API error objects, not RFC 9457 problem details.
      properties:
        jsonapi:
          $ref: '#/components/schemas/JsonApiObject'
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    ResourceIdentifier:
      type: object
      required:
      - type
      - id
      properties:
        type:
          type: string
        id:
          type: string
          description: The related resource's UUID, or the literal sentinel `virtual` that Drupal JSON:API emits for the synthetic root term of a taxonomy hierarchy.
        meta:
          type: object
    JsonApiObject:
      type: object
      description: The `jsonapi` top-level member, present on every response.
      properties:
        version:
          type: string
          const: '1.1'
        meta:
          type: object
    CollectionDocument:
      type: object
      required:
      - jsonapi
      - data
      properties:
        jsonapi:
          $ref: '#/components/schemas/JsonApiObject'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObject'
        included:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObject'
        links:
          $ref: '#/components/schemas/Links'
        meta:
          type: object
    IndividualDocument:
      type: object
      required:
      - jsonapi
      - data
      properties:
        jsonapi:
          $ref: '#/components/schemas/JsonApiObject'
        data:
          $ref: '#/components/schemas/ResourceObject'
        included:
          type: array
          items:
            $ref: '#/components/schemas/ResourceObject'
        links:
          $ref: '#/components/schemas/Links'
    Error:
      type: object
      properties:
        title:
          type: string
        status:
          type: string
        detail:
          type: string
        code:
          type: string
        links:
          type: object
          properties:
            via:
              type: object
              properties:
                href:
                  type: string
                  format: uri
            info:
              type: object
              properties:
                href:
                  type: string
                  format: uri
              description: Points at the HTTP status-code definition, e.g. the RFC section for 400.
    ResourceObject:
      type: object
      required:
      - type
      - id
      description: A JSON:API resource object. `attributes` and `relationships` are bundle-specific Drupal fields; sparse fieldsets narrow them.
      properties:
        type:
          type: string
          description: Resource type in `entity--bundle` form, e.g. `node--article`.
        id:
          type: string
          format: uuid
        links:
          $ref: '#/components/schemas/Links'
        attributes:
          type: object
          additionalProperties: true
        relationships:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/Relationship'
    Links:
      type: object
      description: JSON:API links object. Collections carry `self` and, when more records exist, `next`/`prev`.
      additionalProperties:
        oneOf:
        - type: string
          format: uri
        - type: object
          properties:
            href:
              type: string
              format: uri
            meta:
              type: object
  parameters:
    include:
      name: include
      in: query
      required: false
      description: Comma-separated relationship paths to side-load into the `included` member, e.g. `field_tags,uid`.
      schema:
        type: string
    sort:
      name: sort
      in: query
      required: false
      description: Comma-separated sort fields. Prefix a field with `-` for descending order, e.g. `-created`.
      schema:
        type: string
      example: -created
    fields:
      name: fields
      in: query
      required: false
      style: deepObject
      explode: true
      description: 'Sparse fieldsets, keyed by resource type: `fields[node--article]=title,created`.'
      schema:
        type: object
        additionalProperties:
          type: string
    resourceVersion:
      name: resourceVersion
      in: query
      required: false
      description: Revision selector, e.g. `id:717` or `rel:working-copy`. Emitted by the API in each resource's `links` member.
      schema:
        type: string
    resourceId:
      name: id
      in: path
      required: true
      description: The resource's Drupal UUID.
      schema:
        type: string
        format: uuid
      example: 46f6505d-0014-46ce-95b8-5ba89e7f96f6
    pageLimit:
      name: page[limit]
      in: query
      required: false
      description: Maximum number of resource objects to return. Drupal JSON:API caps this at 50.
      schema:
        type: integer
        minimum: 1
        maximum: 50
        default: 50
      example: 10
    filter:
      name: filter
      in: query
      required: false
      style: deepObject
      explode: true
      description: JSON:API filter expression. Simple form `filter[field]=value`; condition form `filter[label][condition][path]=field&filter[label][condition][operator]=CONTAINS`. An unknown field returns HTTP 400 with a JSON:API error object.
      schema:
        type: object
        additionalProperties: true
    pageOffset:
      name: page[offset]
      in: query
      required: false
      description: Zero-based index of the first resource object to return. Paired with the `next`/`prev` links in the response.
      schema:
        type: integer
        minimum: 0
        default: 0
  responses:
    BadRequest:
      description: Malformed query — for example an unknown filter path.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
          examples:
            unknownFilterField:
              summary: Observed 2026-07-25
              value:
                jsonapi:
                  version: '1.1'
                errors:
                - title: Bad Request
                  status: '400'
                  detail: Invalid nested filtering. The field `nope`, given in the path `nope`, does not exist.
    NotFound:
      description: No resource matches the given identifier, or the resource type is not exposed.
      content:
        application/vnd.api+json:
          schema:
            $ref: '#/components/schemas/ErrorDocument'
          examples:
            unknownUuid:
              summary: Observed 2026-07-25
              value:
                jsonapi:
                  version: '1.1'
                errors:
                - title: Not Found
                  status: '404'
                  detail: The "entity" parameter was not converted for the path "/jsonapi/node/article/{entity}"
externalDocs:
  description: JSON:API v1.1 specification
  url: https://jsonapi.org/format/1.1/
x-security-note: The read surface described here requires no credentials — an empty root `security` array is the accurate statement, verified by anonymous HTTP 200 responses. The write surface returns HTTP 401 'No authentication credentials provided.' and the NAIC documents no public credentialing path for it, so no securityScheme is asserted here.