OSS-first docs

These docs teach the open system first: contracts, generated surfaces, runtimes, governance, and incremental adoption. Studio shows up as the operating layer on top, not as the source of truth.

project-management.jira

Jira Cloud integration for creating and tracking work items.

  • Type: integration (integration)
  • Version: 1.0.0
  • Owners: @platform.integrations
  • Tags: project-management, jira
  • File: packages/libs/contracts-integrations/src/integrations/providers/jira.ts
  • field.key.label
    project-management.jira
    field.version.label
    1.0.0
    field.type.label
    integration (integration)
    field.title.label
    project-management.jira
    field.description.label

    Jira Cloud integration for creating and tracking work items.

  • Type: integration (integration)
  • Version: 1.0.0
  • Owners: @platform.integrations
  • Tags: project-management, jira
  • File: packages/libs/contracts-integrations/src/integrations/providers/jira.ts
  • field.tags.label
    project-management,jira
    field.owners.label
    @platform.integrations
    field.stability.label

    Jira Cloud integration for creating and tracking work items.

    Source Definition

    export const jiraIntegrationSpec = defineIntegration({
    	meta: {
    		key: 'project-management.jira',
    		version: '1.0.0',
    		category: 'project-management',
    		title: 'Jira Cloud',
    		description: 'Jira Cloud integration for creating and tracking work items.',
    		domain: 'productivity',
    		owners: ['@platform.integrations'],
    		tags: ['project-management', 'jira'],
    		stability: StabilityEnum.Beta,
    	},
    	supportedModes: ['managed', 'byok'],
    	transports: [
    		{ type: 'rest' },
    		{
    			type: 'webhook',
    			inbound: {
    				signatureHeader: 'x-atlassian-webhook-signature',
    				signingAlgorithm: 'hmac-sha256',
    			},
    		},
    	],
    	preferredTransport: 'rest',
    	supportedAuthMethods: [
    		{ type: 'basic' },
    		{
    			type: 'oauth2',
    			grantType: 'authorization_code',
    			authorizationUrl: 'https://auth.atlassian.com/authorize',
    			tokenUrl: 'https://auth.atlassian.com/oauth/token',
    			scopes: ['read:jira-work', 'write:jira-work'],
    		},
    	],
    	capabilities: {
    		provides: [{ key: 'project-management.work-items', version: '1.0.0' }],
    	},
    	configSchema: {
    		schema: {
    			type: 'object',
    			required: ['siteUrl'],
    			properties: {
    				siteUrl: {
    					type: 'string',
    					description:
    						'Jira Cloud site URL (e.g., https://acme.atlassian.net).',
    				},
    				projectKey: {
    					type: 'string',
    					description: 'Default Jira project key for new issues.',
    				},
    				issueType: {
    					type: 'string',
    					description: 'Default Jira issue type (e.g., Task, Story).',
    				},
    				defaultLabels: {
    					type: 'array',
    					items: { type: 'string' },
    					description: 'Labels applied to each issue by default.',
    				},
    				issueTypeMap: {
    					type: 'object',
    					additionalProperties: { type: 'string' },
    					description:
    						'Optional mapping from work item types to Jira issue types.',
    				},
    			},
    		},
    		example: {
    			siteUrl: 'https://acme.atlassian.net',
    			projectKey: 'PM',
    			issueType: 'Task',
    		},
    	},
    	secretSchema: {
    		schema: {
    			type: 'object',
    			required: ['email', 'apiToken'],
    			properties: {
    				email: {
    					type: 'string',
    					description: 'Jira account email used for API token auth.',
    				},
    				apiToken: {
    					type: 'string',
    					description: 'Jira Cloud API token for the account.',
    				},
    			},
    		},
    		example: {
    			email: 'user@acme.com',
    			apiToken: 'jira_api_token',
    		},
    	},
    	healthCheck: {
    		method: 'custom',
    		timeoutMs: 4000,
    	},
    	docsUrl: 'https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/',
    	constraints: {},
    	byokSetup: {
    		setupInstructions:
    			'Create a Jira API token and store it with the associated account email.',
    		keyRotationSupported: false,
    		quotaTrackingSupported: false,
    	},
    });