LinkedIn · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for LinkedIn Compliance Events Compliance Authorization API

4 actions 4 updates phrasing extends openapi/linkedin-compliance-authorization-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 4

$.info

$.paths['/v2/memberComplianceAuthorizations'].get

$.paths['/v2/memberComplianceAuthorizations'].post

$.paths['/v2/memberComplianceAuthorizations/developerApplication=urn:li:developerApplication:{DeveloperApplicationId}&member=urn:li:person:{PersonId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for LinkedIn Compliance Events Compliance Authorization API
  version: 1.0.0
extends: openapi/linkedin-compliance-authorization-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['/v2/memberComplianceAuthorizations'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a member is opted in to compliance
      effect: read
      questions:
      - Is this member currently under compliance monitoring?
      - Can I verify a member's regulated status before archiving activity?
      instructions:
      - text: Check the compliance authorization status using finder {q}.
        slots:
          q: query.q
      - text: Tell me whether the member is opted in for compliance monitoring.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/memberComplianceAuthorizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Opt a member in to compliance monitoring
      effect: write
      questions:
      - Can I start archiving a regulated member's LinkedIn activity?
      - What happens after a member is authorized for compliance monitoring?
      instructions:
      - text: Opt member {member} in to compliance monitoring.
        slots:
          member: requestBody.member
      - text: Authorize regulated monitoring for {member}.
        slots:
          member: requestBody.member
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/memberComplianceAuthorizations/developerApplication=urn:li:developerApplication:{DeveloperApplicationId}&member=urn:li:person:{PersonId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Opt a member out of compliance monitoring
      effect: destructive
      questions:
      - Can I stop monitoring a member's activity for compliance?
      - Does an expired access token end compliance monitoring on its own?
      instructions:
      - text: Opt person {PersonId} out of compliance monitoring for app {DeveloperApplicationId}.
        slots:
          PersonId: path.PersonId
          DeveloperApplicationId: path.DeveloperApplicationId
      - text: Stop regulating member {PersonId} under application {DeveloperApplicationId}.
        slots:
          PersonId: path.PersonId
          DeveloperApplicationId: path.DeveloperApplicationId
      method: generated
      generated: '2026-09-26'