Skip to content

Updating Specs

Terminal window
cd forge-clients
pnpm --filter @forge-clients/generator run update-specs

This downloads from:

  • https://developer.atlassian.com/cloud/jira/platform/swagger-v3.v3.json
  • https://developer.atlassian.com/cloud/jira/platform/swagger.v2.json
  • https://developer.atlassian.com/cloud/jira/software/swagger.v3.json
  • https://developer.atlassian.com/cloud/jira/service-desk/swagger.v3.json
  • https://developer.atlassian.com/cloud/confluence/swagger.v3.json

Raw specs are saved to packages/specs/src/raw/ (gitignored). Cleaned specs are saved to packages/specs/src/cleaned/ (committed to git).

Terminal window
# The pipeline generates a diff summary
cat packages/specs/src/diff/jira-v3.diff.json | jq '.summary'
Terminal window
pnpm --filter @forge-clients/generator run generate
Terminal window
pnpm -r run typecheck
pnpm run test
Terminal window
git add packages/specs/src/cleaned/ packages/jira/src/ packages/confluence/src/
git commit -m "chore: regenerate clients from updated Atlassian specs"