Trellis · OpenAPI Overlay 1.0.0

API Evangelist enrichment overlay for the Trellis Public API

14 actions 14 updates documentation
Generated by API Evangelist Written by API Evangelist tooling for Trellis's API. It is a proposal applied on top of the contract, not a document Trellis publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-apievangelist-artifactsx-auth-note

Targets 14

$.info
$.paths['/api/v1/workspaces/{workspaceId}/properties'].get
$.paths['/api/v1/workspaces/{workspaceId}/properties'].post
$.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].get
$.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].put
$.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].patch
$.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].delete
$.paths['/api/v1/workspaces/{workspaceId}/tasks'].get
$.paths['/api/v1/workspaces/{workspaceId}/tasks'].post
$.paths['/api/v1/workspaces/{workspaceId}/tasks/daily-work-orders'].get
$.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].get
$.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].put
$.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].patch
$.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].delete

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enrichment overlay for the Trellis Public API
  version: 1.0.0
x-meta:
  generated: '2026-07-21'
  method: generated
  source: >-
    Generated by API Evangelist against openapi/trellistech-public-api.json. Adds
    operationIds (absent in the source spec) and cross-links to companion artifacts.
    Does not mutate the original OpenAPI document.
  extends: openapi/trellistech-public-api.json
actions:
- target: $.info
  description: Cross-link companion artifacts and note the auth model.
  update:
    x-apievangelist-artifacts:
      authentication: authentication/trellistech-authentication.yml
      conventions: conventions/trellistech-conventions.yml
      errors: errors/trellistech-problem-types.yml
      data-model: data-model/trellistech-data-model.yml
      mcp: mcp/trellistech-mcp.yml
    x-auth-note: >-
      The published spec documents workspace API-key (bearer) auth only. Programmatic
      session access tokens from POST /api/v1/auth/token also work at runtime but are not
      reflected in this spec.
- target: $.paths['/api/v1/workspaces/{workspaceId}/properties'].get
  description: Add a stable operationId for list-properties.
  update:
    operationId: listProperties
- target: $.paths['/api/v1/workspaces/{workspaceId}/properties'].post
  description: Add a stable operationId for create-property.
  update:
    operationId: createProperty
- target: $.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].get
  description: Add a stable operationId for get-property.
  update:
    operationId: getProperty
- target: $.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].put
  description: Add a stable operationId for replace-property.
  update:
    operationId: replaceProperty
- target: $.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].patch
  description: Add a stable operationId for update-property.
  update:
    operationId: updateProperty
- target: $.paths['/api/v1/workspaces/{workspaceId}/properties/{propertyId}'].delete
  description: Add a stable operationId for delete-property.
  update:
    operationId: deleteProperty
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks'].get
  description: Add a stable operationId for list-tasks.
  update:
    operationId: listTasks
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks'].post
  description: Add a stable operationId for create-task.
  update:
    operationId: createTask
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks/daily-work-orders'].get
  description: Add a stable operationId for the daily-work-orders report.
  update:
    operationId: listDailyWorkOrders
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].get
  description: Add a stable operationId for get-task.
  update:
    operationId: getTask
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].put
  description: Add a stable operationId for replace-task.
  update:
    operationId: replaceTask
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].patch
  description: Add a stable operationId for update-task.
  update:
    operationId: updateTask
- target: $.paths['/api/v1/workspaces/{workspaceId}/tasks/{taskId}'].delete
  description: Add a stable operationId for delete-task.
  update:
    operationId: deleteTask