Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced Relationships schema API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/schema/objects/{object_name}/relations'].get
$.paths['/schema/objects/{object_name}/relations'].post
$.paths['/schema/objects/{object_name}/relations/{relation_name}'].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 Advanced Relationships schema API
  version: 1.0.0
extends: openapi/optimizely-relationships-schema-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['/schema/objects/{object_name}/relations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's relationships
      effect: read
      questions:
      - Which relationships does a data platform object have to other objects?
      - Can I see every relation defined on my customers object in ODP?
      instructions:
      - text: List all relations of object {object_name}.
        slots:
          object_name: path.object_name
      - text: Show the relationships defined on the {object_name} object.
        slots:
          object_name: path.object_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_name}/relations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a relationship between objects
      effect: write
      questions:
      - How do I relate one Optimizely Data Platform object to another?
      - Can I choose the join fields that link a parent object to a child object?
      - Can a new relation be made publicly readable?
      instructions:
      - text: Create relation {name} from object {object_name} to child object {child_object} displayed as {display_name}, public read {public_read}.
        slots:
          name: requestBody.name
          object_name: path.object_name
          child_object: requestBody.child_object
          display_name: requestBody.display_name
          public_read: requestBody.public_read
      - text: Link {object_name} to {child_object} as relation {name} using join fields {join_fields}.
        slots:
          object_name: path.object_name
          child_object: requestBody.child_object
          name: requestBody.name
          join_fields: requestBody.join_fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schema/objects/{object_name}/relations/{relation_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one relationship of an object
      effect: read
      questions:
      - What join fields does a specific relation on an object use?
      - Can I inspect a single named relationship of an ODP object?
      instructions:
      - text: Get relation {relation_name} on object {object_name}.
        slots:
          relation_name: path.relation_name
          object_name: path.object_name
      - text: Show the details of the {relation_name} relationship of {object_name}.
        slots:
          relation_name: path.relation_name
          object_name: path.object_name
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay 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 openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • 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 overlay
curl "https://apis.io/api/v1/overlays/optimizely-relationships-schema-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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