OpenAPI specifications for get source

src/api/public/apidocs-new/OBS-v2.10.50.yaml

@@ -255,7 +255,8 @@ paths:
     $ref: 'paths/source_orderkiwirepos.yaml'
 
   # Sources - Projects
-
+  /source:
+    $ref: 'paths/source.yaml'
   /source/{project_name}?cmd=addchannels:
     $ref: 'paths/source_project_name_cmd_addchannels.yaml'
   /source/{project_name}?cmd=copy:

src/api/public/apidocs-new/components/schemas/source/projects.yaml

@@ -0,0 +1,13 @@
+type: array
+items:
+  type: object
+  properties:
+    entry:
+      type: object
+      properties:
+        name:
+          type: string
+          xml:
+            attribute: true
+xml:
+  name: directory

src/api/public/apidocs-new/paths/source.yaml

@@ -0,0 +1,53 @@
+get:
+  summary: List all the projects
+  description: |
+    Get a list of projects
+  parameters:
+    - name: deleted
+      in: query
+      schema:
+        type: integer
+      description: Set to 1 to include deleted projects in the listing. This is available for Admins only.
+      example: 0
+      required: false
+
+  responses:
+    '200':
+      description: OK. The request has succeeded.
+      content:
+        application/xml; charset=utf-8:
+          schema:
+            $ref: '../components/schemas/source/projects.yaml'
+          examples:
+            existing_projects:
+              entry:
+                name: "home:Admin"
+            deleted_projects:
+              entry:
+                name: "home:Admin"
+
+    '400':
+      description: Wrong value for deleted parameter.
+      content:
+        application/xml; charset=utf-8:
+          schema:
+            $ref: '../components/schemas/api_response.yaml'
+          examples:
+            not boolean:
+              value:
+                code: 400
+                summary: "not boolean"
+    '401':
+      $ref: '../components/responses/unauthorized.yaml'
+    '403':
+      description: |
+        No permission to access deleted projects.
+      content:
+        application/xml; charset=utf-8:
+          schema:
+            $ref: '../components/schemas/api_response.yaml'
+          example:
+            code: 'no_permission_for_deleted'
+            summary: only admins can see deleted projects.
+  tags:
+    - Sources - Projects