Snyk · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Snyk AccessRequests Projects API (projects-api)

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

What the actions change

contacttermsOfServicex-providerx-provider-idx-provider-websitex-documentationx-api-referenceservers

Targets 2

$.info
$

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Snyk AccessRequests Projects API (projects-api)
  version: 1.0.0
extends: openapi/snyk-projects-api-openapi.yml
x-provenance:
  generated: '2026-08-27'
  method: generated
  provider: Snyk
  providerId: snyk
  source: Generated by the API Evangelist enrichment pipeline from artifacts already in this repo. Applies API Evangelist annotations only; the
    underlying OpenAPI is never mutated.
actions:
- target: $.info
  description: Attach provider identity and contact so the document is self-describing when detached from apis.yml.
  update:
    contact:
      name: Snyk Support
      url: https://support.snyk.io/
    termsOfService: https://snyk.io/policies/terms-of-service/
    x-provider: Snyk
    x-provider-id: snyk
    x-provider-website: https://snyk.io/
    x-documentation: https://docs.snyk.io/developer-tools/snyk-api
    x-api-reference: https://apidocs.snyk.io/
- target: $
  description: Record the regional base URLs Snyk publishes. Tokens are region-bound; a token issued in one region returns 401 against another.
  update:
    servers:
    - url: https://api.snyk.io/rest
      description: SNYK-US-01
    - url: https://api.us.snyk.io/rest
      description: SNYK-US-02
    - url: https://api.eu.snyk.io/rest
      description: SNYK-EU-01
    - url: https://api.au.snyk.io/rest
      description: SNYK-AU-01
- target: $
  description: Cross-link the machine-readable artifacts this repo derives for this API.
  update:
    x-apievangelist:
      authentication: authentication/snyk-authentication.yml
      scopes: scopes/snyk-scopes.yml
      conventions: conventions/snyk-conventions.yml
      errors: errors/snyk-problem-types.yml
      rate_limits: rate-limits/snyk-rate-limits.yml
      lifecycle: lifecycle/snyk-lifecycle.yml
      conformance: conformance/snyk-conformance.yml
      data_model: data-model/snyk-data-model.yml
      changelog: changelog/snyk-changelog.yml
      plans: plans/snyk-plans-pricing.yml
      webhooks: asyncapi/snyk-webhooks.yml
      mcp: mcp/snyk-mcp.yml
      skills: skills/_index.yml
- target: $
  description: Record the cross-cutting runtime semantics of the Snyk REST API, read from the published contract and documentation.
  update:
    x-conventions:
      media_type: application/vnd.api+json
      standard: JSON:API 1.0
      versioning:
        style: dated query parameter
        parameter: version
        format: YYYY-MM-DD
        current_ga: '2026-03-25'
        stability_trees:
        - ga
        - beta
        - experimental
      pagination:
        style: cursor
        parameters:
        - starting_after
        - ending_before
        - limit
      rate_limit:
        requests: 1620
        window: minute
        scope: api-key
        status: 429
      idempotency:
        supported: false
      deprecation_headers:
      - deprecation
      - sunset
      request_id_header: snyk-request-id