bump API_VERSION to 2.0 for all services

Lotram · Lotram · commit ecaadcb7eeb4 · 2026-06-02T09:55:59.000+02:00
diff --git a/bugwarrior/config/schema.py b/bugwarrior/config/schema.py
@@ -203,10 +203,6 @@ class ServiceConfig(_ServiceConfig):
     service: str
     target: str
 
-    @property
-    def keyring_service(self) -> str:
-        return self.KEYRING_SERVICE.format(**self.model_dump())
-
     # Added during validation (computed field)
     templates: dict[str, str] = {}
 
@@ -217,6 +213,18 @@ def keyring_service(self) -> str:
     add_tags: ConfigList = []
     static_fields: ConfigList = []
 
+    @property
+    def keyring_service(self) -> str:
+        # FIXME change this import and move it outside method after rebase
+        from bugwarrior.collect import get_service
+
+        service = get_service(self.service)
+        if service.API_VERSION < 2:
+            assert hasattr(service, "get_keyring_service")
+            return service.get_keyring_service(self)  # ty: ignore
+
+        return self.KEYRING_SERVICE.format(**self.model_dump())
+
     @model_validator(mode="before")
     @classmethod
     def compute_templates(cls, values: dict[str, Any]) -> dict[str, Any]:
diff --git a/bugwarrior/docs/other-services/api.rst b/bugwarrior/docs/other-services/api.rst
@@ -1,4 +1,4 @@
-Python API v1.0
+Python API v2.0
 ===============
 
 The interfaces documented here are considered stable. All other interfaces
diff --git a/bugwarrior/docs/other-services/tutorial.rst b/bugwarrior/docs/other-services/tutorial.rst
@@ -190,7 +190,7 @@ Now for the main service class which bugwarrior will invoke to fetch issues.
 .. code:: python
 
   class GitBugService(Service):
-      API_VERSION = 1.0
+      API_VERSION = 2.0
       ISSUE_CLASS = GitBugIssue
       CONFIG_SCHEMA = GitBugConfig
 
diff --git a/bugwarrior/services/__init__.py b/bugwarrior/services/__init__.py
@@ -37,7 +37,7 @@
 # spec will cause breakages with older bugwarrior releases.
 # MINOR versions signal extensions of the spec which enhance future releases of
 # bugwarrior without breaking past releases.
-LATEST_API_VERSION = 1.0
+LATEST_API_VERSION = 2.0
 
 
 class URLShortener:
diff --git a/bugwarrior/services/azuredevops.py b/bugwarrior/services/azuredevops.py
@@ -184,7 +184,7 @@ def get_default_description(self) -> str:
 
 
 class AzureDevopsService(Service[AzureDevopsIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = AzureDevopsIssue
     CONFIG_SCHEMA = AzureDevopsConfig
 
diff --git a/bugwarrior/services/bitbucket.py b/bugwarrior/services/bitbucket.py
@@ -81,7 +81,7 @@ def get_default_description(self) -> str:
 
 
 class BitbucketService(Service[BitbucketIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = BitbucketIssue
     CONFIG_SCHEMA = BitbucketConfig
 
diff --git a/bugwarrior/services/bts.py b/bugwarrior/services/bts.py
@@ -104,7 +104,7 @@ def get_priority(self) -> config.Priority:
 
 
 class BTSService(Service[BTSIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = BTSIssue
     CONFIG_SCHEMA = BTSConfig
 
diff --git a/bugwarrior/services/bz.py b/bugwarrior/services/bz.py
@@ -119,7 +119,7 @@ def get_default_description(self) -> str:
 
 
 class BugzillaService(Service[BugzillaIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = BugzillaIssue
     CONFIG_SCHEMA = BugzillaConfig
 
diff --git a/bugwarrior/services/clickup.py b/bugwarrior/services/clickup.py
@@ -121,7 +121,7 @@ def parse_timestamp(
 
 
 class ClickupService(Service[ClickupIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = ClickupIssue
     CONFIG_SCHEMA = ClickupConfig
 
diff --git a/bugwarrior/services/deck.py b/bugwarrior/services/deck.py
@@ -127,7 +127,7 @@ def get_default_description(self) -> str:
 
 
 class NextcloudDeckService(Service[NextcloudDeckIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = NextcloudDeckIssue
     CONFIG_SCHEMA = NextcloudDeckConfig
 
diff --git a/bugwarrior/services/gerrit.py b/bugwarrior/services/gerrit.py
@@ -73,7 +73,7 @@ def get_default_description(self) -> str:
 
 
 class GerritService(Service[GerritIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = GerritIssue
     CONFIG_SCHEMA = GerritConfig
 
diff --git a/bugwarrior/services/gitbug.py b/bugwarrior/services/gitbug.py
@@ -139,7 +139,7 @@ def get_default_description(self) -> str:
 
 
 class GitBugService(Service[GitBugIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = GitBugIssue
     CONFIG_SCHEMA = GitBugConfig
 
diff --git a/bugwarrior/services/github.py b/bugwarrior/services/github.py
@@ -294,7 +294,7 @@ def get_default_description(self) -> str:
 
 
 class GithubService(Service[GithubIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = GithubIssue
     CONFIG_SCHEMA = GithubConfig
 
diff --git a/bugwarrior/services/gitlab.py b/bugwarrior/services/gitlab.py
@@ -518,7 +518,7 @@ def get_default_description(self) -> str:
 
 
 class GitlabService(Service[GitlabIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = GitlabIssue
     CONFIG_SCHEMA = GitlabConfig
 
diff --git a/bugwarrior/services/gmail.py b/bugwarrior/services/gmail.py
@@ -106,7 +106,7 @@ class GmailService(Service[GmailIssue]):
     APPLICATION_NAME = 'Bugwarrior Gmail Service'
     SCOPES = ['https://www.googleapis.com/auth/gmail.readonly']
 
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = GmailIssue
     CONFIG_SCHEMA = GmailConfig
     AUTHENTICATION_LOCK = multiprocessing.Lock()
diff --git a/bugwarrior/services/jira.py b/bugwarrior/services/jira.py
@@ -337,7 +337,7 @@ def get_issue_type(self) -> str:
 
 
 class JiraService(Service[JiraIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = JiraIssue
     CONFIG_SCHEMA = JiraConfig
 
diff --git a/bugwarrior/services/kanboard.py b/bugwarrior/services/kanboard.py
@@ -121,7 +121,7 @@ def _convert_timestamp_from_field(self, field: str) -> datetime.datetime | None:
 
 
 class KanboardService(Service[KanboardIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = KanboardIssue
     CONFIG_SCHEMA = KanboardConfig
 
diff --git a/bugwarrior/services/linear.py b/bugwarrior/services/linear.py
@@ -128,7 +128,7 @@ def get_default_description(self) -> str:
 
 
 class LinearService(Service[LinearIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = LinearIssue
     CONFIG_SCHEMA = LinearConfig
 
diff --git a/bugwarrior/services/logseq.py b/bugwarrior/services/logseq.py
@@ -324,7 +324,7 @@ def get_default_description(self) -> str:
 
 
 class LogseqService(Service[LogseqIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = LogseqIssue
     CONFIG_SCHEMA = LogseqConfig
 
diff --git a/bugwarrior/services/pagure.py b/bugwarrior/services/pagure.py
@@ -14,7 +14,6 @@
 
 
 class PagureConfig(config.ServiceConfig):
-    # strictly required
     service: typing.Literal['pagure']
     KEYRING_SERVICE = "pagure://{base_url}"
     base_url: config.StrippedTrailingSlashUrl
@@ -92,7 +91,7 @@ def get_default_description(self) -> str:
 
 
 class PagureService(Service[PagureIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = PagureIssue
     CONFIG_SCHEMA = PagureConfig
 
diff --git a/bugwarrior/services/phab.py b/bugwarrior/services/phab.py
@@ -86,7 +86,7 @@ def priority(self) -> config.Priority:
 
 
 class PhabricatorService(Service[PhabricatorIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = PhabricatorIssue
     CONFIG_SCHEMA = PhabricatorConfig
 
diff --git a/bugwarrior/services/pivotaltracker.py b/bugwarrior/services/pivotaltracker.py
@@ -111,7 +111,7 @@ def get_default_description(self) -> str:
 
 
 class PivotalTrackerService(Service[PivotalTrackerIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = PivotalTrackerIssue
     CONFIG_SCHEMA = PivotalTrackerConfig
 
diff --git a/bugwarrior/services/redmine.py b/bugwarrior/services/redmine.py
@@ -206,7 +206,7 @@ def get_default_description(self) -> str:
 
 
 class RedMineService(Service[RedMineIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = RedMineIssue
     CONFIG_SCHEMA = RedMineConfig
 
diff --git a/bugwarrior/services/taiga.py b/bugwarrior/services/taiga.py
@@ -61,7 +61,7 @@ def get_default_description(self) -> str:
 
 
 class TaigaService(Service[TaigaIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = TaigaIssue
     CONFIG_SCHEMA = TaigaConfig
 
diff --git a/bugwarrior/services/teamwork_projects.py b/bugwarrior/services/teamwork_projects.py
@@ -94,7 +94,7 @@ def to_taskwarrior(self) -> dict[str, Any]:
 
 
 class TeamworkService(Service[TeamworkIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = TeamworkIssue
     CONFIG_SCHEMA = TeamworkConfig
 
diff --git a/bugwarrior/services/todoist.py b/bugwarrior/services/todoist.py
@@ -183,7 +183,7 @@ def get_default_description(self) -> str:
 
 
 class TodoistService(Service[TodoistIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = TodoistIssue
     CONFIG_SCHEMA = TodoistConfig
 
diff --git a/bugwarrior/services/trac.py b/bugwarrior/services/trac.py
@@ -79,7 +79,7 @@ def get_priority(self) -> config.Priority:
 
 
 class TracService(Service[TracIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = TracIssue
     CONFIG_SCHEMA = TracConfig
     trac: offtrac.TracServer | None
diff --git a/bugwarrior/services/trello.py b/bugwarrior/services/trello.py
@@ -87,7 +87,7 @@ def to_taskwarrior(self) -> dict[str, Any]:
 
 
 class TrelloService(Service[TrelloIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = TrelloIssue
     CONFIG_SCHEMA = TrelloConfig
 
diff --git a/bugwarrior/services/youtrack.py b/bugwarrior/services/youtrack.py
@@ -111,7 +111,7 @@ def get_tags(self) -> list[str]:
 
 
 class YoutrackService(Service[YoutrackIssue]):
-    API_VERSION = 1.0
+    API_VERSION = 2.0
     ISSUE_CLASS = YoutrackIssue
     CONFIG_SCHEMA = YoutrackConfig
 
diff --git a/tests/base.py b/tests/base.py
@@ -34,7 +34,7 @@ def to_taskwarrior(self):
 
 
 class DumbService(services.Service):
-    API_VERSION = 1.0
+    API_VERSION = services.LATEST_API_VERSION
     ISSUE_CLASS = DumbIssue
     CONFIG_SCHEMA = DumbConfig
 
diff --git a/tests/test_service.py b/tests/test_service.py
@@ -5,7 +5,7 @@
 import unittest.mock
 
 from bugwarrior import services
-from bugwarrior.config import validation
+from bugwarrior.config import ServiceConfig, validation
 from bugwarrior.config.load import format_config
 
 from .base import ConfigTest, DumbService
@@ -101,6 +101,20 @@ def test_api_latest_version(self):
 
         self.assertEqual(latest_documented, services.LATEST_API_VERSION)
 
+    def test_api_v1_keyring_service_backwards_compatibility(self):
+        class LegacyService:
+            API_VERSION = 1.0
+
+            @staticmethod
+            def get_keyring_service(config):
+                return f'legacy://{config.target}'
+
+        service_config = ServiceConfig(service='legacy', target='legacy-target')
+        with unittest.mock.patch(
+            'bugwarrior.collect.get_service', lambda _: LegacyService
+        ):
+            self.assertEqual(service_config.keyring_service, 'legacy://legacy-target')
+
 
 class TestIssue(ServiceBase):
     def test_architecture(self):

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Python API v1.0`
	`1`	`+Python API v2.0`
`2`	`2`	`===============`
`3`	`3`
`4`	`4`	`The interfaces documented here are considered stable. All other interfaces`