Skip to content

Real-world use cases

The examples/Okatana.Examples project contains executable scenarios that combine multiple API calls into production-style workflows. The examples intentionally use descriptive file names without numeric prefixes.

Scenario Source file Main API areas
Project bootstrap BootstrapProject.cs project creation, boards, board reorder
CI/CD release CiCdReleaseWorkflow.cs ticket search/create/move/comment
Incident response IncidentResponseWorkflow.cs critical ticket creation and workflow transition
Document publishing DocumentPublishingPipeline.cs document create/comment/publish
Analytics report AnalyticsReport.cs analytics
Ticket export ExportAllTickets.cs paginated async enumeration
External tracker sync ExternalTrackerSync.cs reconciliation marker and update/create
Custom HTTP CustomHttpClient.cs delegating handler and per-call headers
Board consolidation BoardConsolidation.cs list/move/delete board workflow
Release notes PublishReleaseNotes.cs enumerate tickets and publish document

Run a scenario with:

dotnet run --project examples/Okatana.Examples -- bootstrap-project

Set OKATANA_URL, OKATANA_API_KEY, OKATANA_ORGANIZATION_ID, and where required OKATANA_PROJECT_ID. Use a non-production deployment until the workflow and scopes are verified.