Puzzle · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Puzzle Accounting API

3 actions 3 updates security extends openapi/puzzle-openapi-original.json
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-ratingx-apievangelist-notessecuritySchemes

Targets 3

$.info
$.servers
$.components

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Puzzle Accounting API
  version: 1.0.0
extends: openapi/puzzle-openapi-original.json
actions:
- target: $.info
  update:
    x-apievangelist-provider: puzzle
    x-apievangelist-rating: 4
    x-apievangelist-notes: >-
      Puzzle publishes a complete OpenAPI 3.0.3 (81 operations) via ReadMe. The harvested
      spec declares the sandbox server only and omits securitySchemes; the enhancements
      below record the production server and the documented OAuth 2.0 + PKCE model without
      mutating the original.
- target: $.servers
  update:
  - url: https://api.puzzle.io/rest/v0
    description: Production (added by API Evangelist; docs getting-started)
  - url: https://staging.southparkdata.com/rest/v0
    description: Sandbox (as declared in the original spec)
- target: $.components
  update:
    securitySchemes:
      OAuth2:
        type: oauth2
        description: >-
          OAuth 2.0 Authorization Code flow with PKCE (from docs; not declared in the
          original spec). See authentication/puzzle-authentication.yml and
          scopes/puzzle-scopes.yml.
        flows:
          authorizationCode:
            authorizationUrl: https://api.puzzle.io/oauth/authorize
            tokenUrl: https://api.puzzle.io/oauth/token
            scopes:
              read:company: Grants read-only access to company data.
              offline_access: Allows obtaining a refresh token for long-lived access.