tree: 84ed9622f56472c8ab7f7eb96da324b49607daf4 [path history] [tgz]
  1. BUILD_for_publishing_api_only
  2. README.md
  3. admin.ts
  4. annotation.ts
  5. attribute-helper.ts
  6. change-actions.ts
  7. change-reply.ts
  8. checks.ts
  9. core.ts
  10. diff.ts
  11. embed.ts
  12. event-helper.ts
  13. gerrit.ts
  14. hook.ts
  15. package.json
  16. plugin.ts
  17. popup.ts
  18. publish.sh
  19. reporting.ts
  20. rest-api.ts
  21. rest.ts
  22. styles.ts
  23. tsconfig.json
polygerrit-ui/app/api/README.md

Gerrit TypeScript Plugin API

This package contains the types for developing browser plugins for the Gerrit Code Review web application. General documentation for plugin developers can be found at gerrit-review.googlesource.com.

The .ts files only contain types, interfaces and enums, and thus the compiled .js files only contain the enums. For JavaScript plugins this package is not really useful or necessary, but it also serves as the source of truth for what plugin APIs are actually supported.

Versioning of this API matches the MAJOR and MINOR versions of the general Gerrit releases, but the PATCH version is independent. When you are building a plugin for Gerrit x.y.z, then you should use the API package x.y.n, where n is the highest available patch version of the API. Patch versions will only contain additions and fixes, minor versions may include API removals.

All types in here should use the declare keyword to prevent bundlers from renaming fields, which would break communication across separately built bundles. enums are the exception, because their keys are not referenced across bundles, and values will not be renamed by bundlers as they are strings.

This API is also used by other apps embedding gr-diff and any breaking changes should be discussed with the Gerrit core team and properly versioned.