Skip to content

Decouple SWML schemas from REST operation models - #621

Open
Devon-White wants to merge 9 commits into
mainfrom
Devon/swml-object-unreferenced-emit
Open

Decouple SWML schemas from REST operation models#621
Devon-White wants to merge 9 commits into
mainfrom
Devon/swml-object-unreferenced-emit

Conversation

@Devon-White

@Devon-White Devon-White commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • replace direct Calling and Messaging SWML document references in REST operations with open object schemas
  • keep the full Calling and Messaging schemas in OpenAPI as unreferenced components through a service-level SWMLDocument union
  • expose a shallow AI Agent model with reusable descriptions and links to the canonical SWML reference
  • add compact manual request and success-response examples wherever REST operations carry AI or SWML data
  • cover AI Agents, Call Flows and versions, SWML Scripts, generic Fabric resources, and inline SWML Call commands
  • include both Calling and Messaging SWML Script variants without expanding the complete SWML or AI graphs

Validation

  • yarn build:specs
  • TypeSpec formatting check
  • validated 77 emitted manual media examples against their OpenAPI request or response schemas
  • validated all 26 embedded SWML documents against the emitted Calling or Messaging draft-2020-12 JSON Schema
  • validated shallow AI Agent configurations against the canonical SWML AIObject definition
  • confirmed SWMLDocument, SWML.Calling.SWMLObject, and SWML.Messaging.SWMLObject emit under components.schemas
  • confirmed none of those schemas are referenced from operations
  • git diff --check
  • local fern check reached the final FDR redirects comparison; FDR returned 403, so CI will perform that remote check

@github-actions

github-actions Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant