Pluralsight · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Pluralsight REST Reports API

4 actions 4 updates update extends pluralsight-reports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Pluralsight's API. It is a proposal applied on top of the contract, not a document Pluralsight publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-api-evangelistx-sunsetdeprecatedx-rate-limit-contract

Targets 3

$.info
$.paths.*.*
$.paths.*.*.responses

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Pluralsight REST Reports API
  version: 1.0.0
extends: pluralsight-reports-api-openapi.yml
x-generated: '2026-08-29'
x-method: generated
x-source: API Evangelist enrichment pipeline; derived from developer.pluralsight.com docs and live probes
  2026-08-29
actions:
- target: $.info
  description: Stamp API Evangelist provenance and the artifacts derived from this contract.
  update:
    x-api-evangelist:
      repository: https://github.com/api-evangelist/pluralsight
      enriched: '2026-08-29'
      conventions: conventions/pluralsight-conventions.yml
      errors: errors/pluralsight-problem-types.yml
      lifecycle: lifecycle/pluralsight-lifecycle.yml
      authentication: authentication/pluralsight-authentication.yml
      rate_limits: rate-limits/pluralsight-rate-limits.yml
- target: $.info
  description: Record the published removal date for the REST surface this contract describes.
  update:
    x-sunset:
      removed: '2025-11-10'
      notice_phase_start: '2025-02-10'
      no_support_phase_start: '2025-08-10'
      source: https://developer.pluralsight.com/docs/deprecations/2025-deprecation-guide
- target: $.paths.*.*
  description: Mark every operation on this retired REST surface as deprecated.
  update:
    deprecated: true
- target: $.paths.*.*.responses
  description: 'Document the throttling contract observed and published for these APIs: 429 on exhaustion,
    no numeric limit and no RateLimit-* headers published.'
  update:
    x-rate-limit-contract:
      status_on_exhaustion: 429
      headers: []
      published_numeric_limit: false
      guidance: Exponential backoff with jitter; keep page size at or below the documented 1000-record
        recommendation.
      source: https://developer.pluralsight.com/docs/getting-started/faqs