feat: add visibility field to GET /repository response (#1214)

Closes #1213.

Author: leafty

components/renku_data_services/repositories/api.spec.yaml

@@ -55,9 +55,12 @@ components:
           type: boolean
         push_permission:
           type: boolean
+        visibility:
+          $ref: "#/components/schemas/RepositoryVisibility"
       required:
         - git_url
         - pull_permission
+        - visibility
     RepositoryProviderData:
       type: object
       additionalProperties: false
@@ -115,31 +118,6 @@ components:
         - id
         - name
         - url
-    RepositoryMetadata:
-      type: object
-      additionalProperties: false
-      properties:
-        git_http_url:
-          $ref: "#/components/schemas/WebUrl"
-        web_url:
-          $ref: "#/components/schemas/WebUrl"
-        permissions:
-          $ref: "#/components/schemas/RepositoryPermissions"
-      required:
-        - git_http_url
-        - web_url
-        - permissions
-    RepositoryPermissions:
-      type: object
-      additionalProperties: false
-      properties:
-        pull:
-          type: boolean
-        push:
-          type: boolean
-      required:
-        - pull
-        - push
     Ulid:
       description: ULID identifier
       type: string
@@ -150,10 +128,15 @@ components:
       description: ID of a OAuth2 provider, e.g. "gitlab.com".
       type: string
       example: "some-id"
-    WebUrl:
-      description: A URL which can be opened in a browser, i.e. a web page.
+    RepositoryVisibility:
+      description: |
+        The visibility of a repository:
+        - public: the repository can be pulled without credentials
+        - private: the repository requires credentials to be pulled
       type: string
-      example: "https://example.org"
+      enum:
+        - public
+        - private
     ErrorResponse:
       type: object
       properties:

components/renku_data_services/repositories/apispec.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  api.spec.yaml
-#   timestamp: 2025-11-26T07:52:19+00:00
+#   timestamp: 2026-02-17T12:23:26+00:00
 
 from __future__ import annotations
 
@@ -11,16 +11,6 @@
 from renku_data_services.repositories.apispec_base import BaseAPISpec
 
 
-class Metadata(BaseAPISpec):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    git_url: str
-    web_url: Optional[str] = None
-    pull_permission: bool
-    push_permission: Optional[bool] = None
-
-
 class Status(Enum):
     valid = "valid"
     invalid = "invalid"
@@ -40,12 +30,9 @@ class ErrorCode(Enum):
     metadata_validation = "metadata_validation"
 
 
-class RepositoryPermissions(BaseAPISpec):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    pull: bool
-    push: bool
+class RepositoryVisibility(Enum):
+    public = "public"
+    private = "private"
 
 
 class Error(BaseAPISpec):
@@ -66,6 +53,17 @@ class RepositoryGetParametersQuery(BaseAPISpec):
     url: str
 
 
+class Metadata(BaseAPISpec):
+    model_config = ConfigDict(
+        extra="forbid",
+    )
+    git_url: str
+    web_url: Optional[str] = None
+    pull_permission: bool
+    push_permission: Optional[bool] = None
+    visibility: RepositoryVisibility
+
+
 class ProviderConnection(BaseAPISpec):
     id: str = Field(
         ...,
@@ -92,23 +90,6 @@ class ProviderData(BaseAPISpec):
     url: str
 
 
-class RepositoryMetadata(BaseAPISpec):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    git_http_url: str = Field(
-        ...,
-        description="A URL which can be opened in a browser, i.e. a web page.",
-        examples=["https://example.org"],
-    )
-    web_url: str = Field(
-        ...,
-        description="A URL which can be opened in a browser, i.e. a web page.",
-        examples=["https://example.org"],
-    )
-    permissions: RepositoryPermissions
-
-
 class RepositoryProviderData(BaseAPISpec):
     model_config = ConfigDict(
         extra="forbid",

components/renku_data_services/repositories/blueprints.py

@@ -75,6 +75,7 @@ def _make_result(self, r: models.RepositoryDataResult) -> apispec.RepositoryProv
                 web_url=r.metadata.web_url,
                 pull_permission=r.metadata.pull_permission,
                 push_permission=r.metadata.push_permission,
+                visibility=apispec.RepositoryVisibility(r.metadata.visibility.value),
             )
             if r.metadata and r.metadata != "Unmodified"
             else None

components/renku_data_services/repositories/db.py

@@ -97,7 +97,12 @@ async def get_repository(
             # don't overwrite previous errors
             result = result.with_error(repo_err) if not result.error else result
             if repo_err is None:
-                result = result.with_metadata(models.Metadata(git_url=valid_url.render(), pull_permission=True))
+                # NOTE: we assume public visibility since we can request git-upload-pack
+                result = result.with_metadata(
+                    models.Metadata(
+                        git_url=valid_url.render(), pull_permission=True, visibility=models.RepositoryVisibility.public
+                    )
+                )
 
         return result
 

components/renku_data_services/repositories/external_models.py

@@ -81,6 +81,11 @@ def to_repository(
                 if self.permissions is not None
                 else default_permissions or models.RepositoryPermissions.default()
             ),
+            visibility=(
+                models.RepositoryVisibility.public
+                if self.visibility == GitLabVisibility.public.value
+                else models.RepositoryVisibility.private
+            ),
         )
 
 
@@ -127,4 +132,9 @@ def to_repository(
                 if self.permissions is not None
                 else default_permissions or models.RepositoryPermissions.default()
             ),
+            visibility=(
+                models.RepositoryVisibility.public
+                if self.visibility == GitHubVisibility.public.value
+                else models.RepositoryVisibility.private
+            ),
         )

components/renku_data_services/repositories/models.py

@@ -26,6 +26,15 @@ def default(cls) -> RepositoryPermissions:
         return cls(pull=False, push=False)
 
 
+@dataclass(frozen=True, eq=True, kw_only=True)
+class RepositoryProviderData:
+    """Repository provider match data."""
+
+    provider: ProviderData
+    connection: ProviderConnection | None
+    repository_metadata: RepositoryMetadata | None
+
+
 @dataclass(frozen=True, eq=True, kw_only=True)
 class RepositoryMetadata:
     """Repository metadata."""
@@ -34,6 +43,7 @@ class RepositoryMetadata:
     git_http_url: str
     web_url: str
     permissions: RepositoryPermissions
+    visibility: RepositoryVisibility
 
 
 @dataclass(frozen=True, eq=True, kw_only=True)
@@ -73,13 +83,15 @@ def fromORM(cls, e: OAuth2ClientORM) -> ProviderData:
         return ProviderData(id=e.id, name=e.display_name, url=e.url)
 
 
-@dataclass(frozen=True, eq=True, kw_only=True)
-class RepositoryProviderData:
-    """Repository provider match data."""
+class RepositoryVisibility(StrEnum):
+    """The visibility of a repository.
 
-    provider: ProviderData
-    connection: ProviderConnection | None
-    repository_metadata: RepositoryMetadata | None
+    public: the repository can be pulled without credentials
+    private: the repository requires credentials to be pulled
+    """
+
+    public = "public"
+    private = "private"
 
 
 @dataclass(frozen=True, eq=True, kw_only=True)
@@ -91,6 +103,7 @@ class Metadata:
     web_url: str | None = None
     pull_permission: bool
     push_permission: bool | None = None
+    visibility: RepositoryVisibility = RepositoryVisibility.private
 
     @classmethod
     def fromRepoMeta(cls, rm: RepositoryMetadata) -> Metadata:
@@ -101,6 +114,7 @@ def fromRepoMeta(cls, rm: RepositoryMetadata) -> Metadata:
             web_url=rm.web_url,
             pull_permission=rm.permissions.pull,
             push_permission=rm.permissions.push,
+            visibility=rm.visibility,
         )