Skip to content

Add OSOP workflow example — API data sync in portable format#8670

Open
Archie0125 wants to merge 1 commit intowindmill-labs:mainfrom
Archie0125:add-osop-example
Open

Add OSOP workflow example — API data sync in portable format#8670
Archie0125 wants to merge 1 commit intowindmill-labs:mainfrom
Archie0125:add-osop-example

Conversation

@Archie0125
Copy link
Copy Markdown

@Archie0125 Archie0125 commented Apr 2, 2026

Summary

  • Adds an OSOP (Open Standard for Orchestration Protocols) workflow example under examples/osop/
  • The example models a typical API data sync workflow: webhook trigger, payload validation, external API enrichment with retry logic, data transformation, database storage, and Slack notification
  • Includes a README explaining the OSOP format and how to validate/visualize the workflow

What is OSOP?

OSOP is a portable YAML-based workflow standard — think "OpenAPI for workflows." It lets you describe multi-step processes (including API integrations and automation workflows) in a tool-agnostic format that any orchestration engine can read.

Why this PR?

This is a non-invasive, additive-only contribution. The .osop file provides a portable representation of a Windmill-style automation workflow that can be shared, diffed, and rendered by any OSOP-compatible tool — useful for documentation, onboarding, and cross-tool interoperability.

No existing files are modified.


Summary by cubic

Adds an OSOP workflow example for a webhook-driven API data sync. Includes a portable .osop file and a README with validation and visualization instructions.

  • New Features
    • examples/osop/api-data-sync.osop: trigger → validate → enrich (retries) → transform → DB upsert → Slack notify; includes error path to Slack on enrichment failure.
    • examples/osop/README.md: overview of OSOP and steps to run osop validate and npx osop-report for visualization.

Written for commit 297ffec. Summary will update on new commits.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 2, 2026

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 2 files

@Archie0125
Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

1 similar comment
@Archie0125
Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Apr 2, 2026
@Archie0125
Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

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