LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Community Management Use Cases > Organization Lookup > Organization Brands API

5 actions 5 updates phrasing extends openapi/linkedin-use-cases-organization-lookup-organization-brands-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for LinkedIn's API. It is a proposal applied on top of the contract, not a document LinkedIn publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/organizations'].get
$.paths['/organizationBrands'].get
$.paths['/organizationBrands/{organizationBrand_id}'].get
$.paths['/organizationBrandsLookup'].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 Community Management Use Cases > Organization Lookup > Organization Brands API
  version: 1.0.0
extends: openapi/linkedin-use-cases-organization-lookup-organization-brands-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: 4
- target: $.paths['/organizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Find brands under a parent organization
      effect: read
      questions:
      - Which brand pages belong to a parent company I administer?
      - Can I list showcase brands by parent organization?
      instructions:
      - text: Find organization brands under parent {parent}.
        slots:
          parent: query.parent
      - text: List brand pages whose parent is {parent}.
        slots:
          parent: query.parent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizationBrands'].get
  update:
    x-apievangelist-phrasing:
      intent: Batch get brands I administer
      effect: read
      questions:
      - Can I fetch several organization brands I manage at once?
      - What details do my administered brand pages have?
      instructions:
      - text: Batch get administered organization brands {ids}.
        slots:
          ids: query.ids
      - text: Retrieve my managed brand pages {ids} in one request.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizationBrands/{organizationBrand_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve one brand I administer
      effect: read
      questions:
      - What does one of my administered brand pages look like?
      - Can I retrieve a single organization brand by ID?
      instructions:
      - text: Retrieve organization brand {organizationBrand_id}.
        slots:
          organizationBrand_id: path.organizationBrand_id
      - text: Show the full profile of my brand {organizationBrand_id}.
        slots:
          organizationBrand_id: path.organizationBrand_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/organizationBrandsLookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up brands I don't administer
      effect: read
      questions:
      - Can I look up public details of brands I don't manage?
      - Which brand pages can I retrieve without admin rights?
      instructions:
      - text: Look up non-administered organization brands {ids}.
        slots:
          ids: query.ids
      - text: Get public brand details for {ids} that I don't manage.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'