dotCMS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for dotCMS REST Relationships API

3 actions 3 updates phrasing extends openapi/dotcms-relationships-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 3

$.info
$.paths['/api/v1/relationships/cardinalities'].get
$.paths['/api/v1/relationships'].get

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 Relationships API
  version: 1.0.0
extends: openapi/dotcms-relationships-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: 2
- target: $.paths['/api/v1/relationships/cardinalities'].get
  update:
    x-apievangelist-phrasing:
      intent: List relationship cardinality options
      effect: read
      questions:
      - What cardinalities can a content relationship have, like one-to-many?
      - Which relationship types are supported between content types?
      instructions:
      - text: List the available relationship cardinalities.
      - text: Show the one-to-one, one-to-many and many-to-many options.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/relationships'].get
  update:
    x-apievangelist-phrasing:
      intent: List one-sided relationships for a content type
      effect: read
      questions:
      - Which relationships are defined on only one side of a content type?
      - How do I find relationships I can still add the other side for?
      instructions:
      - text: List one-sided relationships for content type {contentTypeId}.
        slots:
          contentTypeId: query.contentTypeId
      - text: Show page {page} of one-sided relationships.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'