Makeswift · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay for the Makeswift REST API

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

What the actions change

x-api-evangelist-slugx-docsx-authenticationx-base-urlx-resourcesx-paginationx-error-envelope

Targets 3

$.info
$.paths['/v2/sites']['get']
$.components

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for the Makeswift REST API
  version: 1.0.0
extends: ../openapi/makeswift-openapi.json
x-metadata:
  generated: '2026-07-20'
  method: generated
  source: derived from openapi/makeswift-openapi.json + docs.makeswift.com
actions:
- target: $.info
  description: Add contact and documentation context captured during enrichment.
  update:
    x-api-evangelist-slug: makeswift
    x-docs: https://docs.makeswift.com/developer/api-reference/overview
    x-authentication: https://docs.makeswift.com/developer/api-reference/authentication
    x-base-url: https://api.makeswift.com
- target: $.info
  description: Annotate the resource model surfaced by this API.
  update:
    x-resources:
    - sites
    - locales
    - pages
- target: $.paths['/v2/sites']['get']
  description: Note the cursor-based pagination convention (limit + startingAfter, hasMore).
  update:
    x-pagination:
      style: cursor
      params:
      - limit
      - startingAfter
      response_flag: hasMore
- target: $.components
  description: Note the shared error envelope shape used across 4xx responses.
  update:
    x-error-envelope:
      media_type: application/json
      shape: '{ object, code, message }'
      codes:
      - bad_request
      - forbidden
      - not_found
      - conflict