dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Elasticsearch Content Search API

4 actions 4 updates phrasing extends openapi/dotcms-elasticsearch-content-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for dotCMS's API. It is a proposal applied on top of the contract, not a document dotCMS publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/es/layout/{params}'].get
$.paths['/api/es/search'].post
$.paths['/api/es/raw'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Elasticsearch Content Search API
  version: 1.0.0
extends: openapi/dotcms-elasticsearch-content-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/api/es/layout/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the search portlet layout
      effect: read
      questions:
      - What does the Elasticsearch portlet layout endpoint return?
      - Can I load the search tool's layout with path parameters?
      instructions:
      - text: Get the Elasticsearch portlet layout for {params}.
        slots:
          params: path.params
      - text: Load the ES search tool layout using {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/es/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search content with a JSON query
      effect: read
      questions:
      - How do I search dotCMS content with an Elasticsearch-style JSON query?
      - Can I include related content in search results, and how deep?
      - Can I limit a query to live content only?
      instructions:
      - text: Search content with my JSON query, returning related content to depth {depth}.
        slots:
          depth: query.depth
      - text: 'Run this JSON content search against live content only: {live}.'
        slots:
          live: query.live
      - text: Search content as user {userid} with full category details.
        slots:
          userid: query.userid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/es/raw'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a raw search query
      effect: read
      questions:
      - Can I get the unprocessed search engine response for a JSON query?
      - Is there a search that returns hits and aggregations without contentlet processing?
      instructions:
      - text: Run this raw JSON query and return the search engine's unprocessed response.
      - text: Execute my aggregation query as a raw search.
      method: generated
      generated: '2026-09-26'