Reelables · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Reelables API

8 actions 8 updates documentation extends openapi/got-its-openapi-original.yml
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

operationIdx-apievangelist-ratingx-apievangelist-notes

Targets 8

$.info
$.tags
$.paths['/assets/{assetId}'].get
$.paths['/workspaces'].get
$.paths['/workspaces/{workspaceId}/assets'].get
$.paths['/workspaces/{workspaceId}/assets'].post
$.paths['/assets/{assetId}/locations'].get
$.paths['/consignments/{consignmentId}'].get

OpenAPI Overlay

Raw ↑
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Reelables API
  version: 1.0.0
extends: openapi/got-its-openapi-original.yml
actions:
- target: $.info
  update:
    x-apievangelist-rating: 3
    x-apievangelist-notes: >-
      Enriched by the API Evangelist enrichment pipeline. Source spec (v1.3.11) is complete on
      paths/schemas/responses but ships no operationIds and no tag descriptions; overlay records
      recommended operationIds and cross-cutting conventions. OAuth2 client-credentials, cursor
      pagination (limit + nextToken), JSON:API-style error envelope, 429 rate limiting.
- target: $.tags
  update:
  - name: Assets
    description: Retrieve, modify and delete tracked assets, their labels, and location/temperature/facility history.
  - name: Consignments
    description: Manage shipments (consignments) and their gateways and pieces.
  - name: Facilities
    description: Access facilities and their asset groups.
  - name: Print jobs
    description: Manage print jobs and their statuses.
  - name: Printers
    description: Queue print jobs to printers.
  - name: Spaces
    description: Create and manage physical spaces and their gateway associations.
  - name: Workspaces
    description: The permissions boundary that owns assets, consignments, facilities, templates and printers.
- target: $.paths['/assets/{assetId}'].get
  update:
    operationId: getAsset
- target: $.paths['/workspaces'].get
  update:
    operationId: listWorkspaces
- target: $.paths['/workspaces/{workspaceId}/assets'].get
  update:
    operationId: listWorkspaceAssets
- target: $.paths['/workspaces/{workspaceId}/assets'].post
  update:
    operationId: createWorkspaceAssets
- target: $.paths['/assets/{assetId}/locations'].get
  update:
    operationId: getAssetLocations
- target: $.paths['/consignments/{consignmentId}'].get
  update:
    operationId: getConsignment