feat: Add additional endpoints for reading various parts of WG data

Issue #9 (closed)

spec/openapi.yaml

@@ -6,16 +6,24 @@ info:
    license:
       name: Eclipse Public License - 2.0
       url: https://www.eclipse.org/legal/epl-2.0/
+
 servers:
 -  url: https://membership.eclipse.org/api
    description: Production endpoint for the membership portal data
+
 paths:
    /working_groups:
       get:
          tags:
          - Working Groups
          summary: Working Group List
-         description: Returns a working group entry that has a matching ID 
+         description: Returns a list of working groups that have the desired status
+         parameters: 
+         -  name: status
+            in: query
+            schema:
+               type: string
+            description: The project status 
          responses:
             200:
                description: Success
@@ -25,6 +33,7 @@ paths:
                         $ref: '#/components/schemas/WorkingGroups'
             500:
                description: Error while retrieving data
+
    /working_groups/{alias}:
       parameters:
       -  name: alias
@@ -43,13 +52,86 @@ paths:
                   application/json:
                      schema:
                         $ref: '#/components/schemas/WorkingGroup'
+            404:
+               description: Not Found
+            500:
+               description: Error while retrieving data
+
+   /working_groups/{alias}/resources:
+      parameters:
+      -  name: alias
+         in: path
+         description: The name of the working group to retrieve
+         required: true
+         schema:
+            type: string
+      get:
+         summary: Working Group resources
+         description: Returns the resources info for the WG with the specified alias
+         responses:
+            200:
+               description: Success
+               content:
+                  application/json:
+                     schema:
+                        $ref: '#/components/schemas/WorkingGroupResources'
+            404:
+               description: Not Found
+            500:
+               description: Error while retrieving data               
+
+   /working_groups/{alias}/levels:
+      parameters:
+      -  name: alias
+         in: path
+         description: The name of the working group to retrieve
+         required: true
+         schema:
+            type: string
+      get:
+         summary: Working Group levels
+         description: Returns the levels info for the WG with the specified alias
+         responses:
+            200:
+               description: Success
+               content:
+                  application/json:
+                     schema:
+                        $ref: '#/components/schemas/WorkingGroupLevels'
+            404:
+               description: Not Found
+            500:
+               description: Error while retrieving data
+
+   /working_groups/{alias}/agreements:
+      parameters:
+      -  name: alias
+         in: path
+         description: The name of the working group to retrieve
+         required: true
+         schema:
+            type: string
+      get:
+         summary: Working Group agreements
+         description: Returns the participation agreements info for the WG with the specified alias
+         responses:
+            200:
+               description: Success
+               content:
+                  application/json:
+                     schema:
+                        $ref: '#/components/schemas/WorkingGroupParticipationAgreements'
+            404:
+               description: Not Found
             500:
                description: Error while retrieving data
+
 components:
    securitySchemes:
       openId:
          type: openIdConnect
          openIdConnectUrl: https://auth.eclipse.org/auth/realms/foundation/.well-known/openid-configuration
+   
    schemas:
       ObjectID:
          description: Unique identifier for an addressable object in the API. Can be null when posting or updating objects in the API if part of the root element or is a new entity. Should always be set in responses.
@@ -57,10 +139,12 @@ components:
             - string
             - 'null'
          minimum: 1
+      
       WorkingGroups:
          type: array
          items:
             $ref: '#/components/schemas/WorkingGroup'
+      
       WorkingGroup:
          type: object
          properties:
@@ -83,31 +167,36 @@ components:
                $ref: '#/components/schemas/WorkingGroupResources'
             levels:
                $ref: '#/components/schemas/WorkingGroupLevels'
+      
       WorkingGroupResources:
-        type: object
-        properties:
-          charter:
-             type: string
-             description: Link to the charter for the current working group
-          contact_form:
-             type: string
-             description: URL link to the contact form
-          members:
-             type: string
-             description: URL to the members list for the given working group
-          participation_agreements:
-             type: object
-             properties:
-                individual:
-                   $ref: '#/components/schemas/WorkingGroupParticipationAgreement'
-                organization:
-                   $ref: '#/components/schemas/WorkingGroupParticipationAgreement'
-          sponsorship:
-             type: string
-             description: link to the sponsorship agreement document
-          website:
-             type: string
-             description: the URL for the homepage of this working group
+         type: object
+         properties:
+            charter:
+               type: string
+               description: Link to the charter for the current working group
+            contact_form:
+               type: string
+               description: URL link to the contact form
+            members:
+               type: string
+               description: URL to the members list for the given working group
+            participation_agreements:
+               $ref: '#/components/schemas/WorkingGroupParticipationAgreements'     
+            sponsorship:
+               type: string
+               description: link to the sponsorship agreement document
+            website:
+               type: string
+               description: the URL for the homepage of this working group
+      
+      WorkingGroupParticipationAgreements:
+         type: object
+         properties:
+            individual:
+               $ref: '#/components/schemas/WorkingGroupParticipationAgreement'
+            organization:
+               $ref: '#/components/schemas/WorkingGroupParticipationAgreement'
+               
       WorkingGroupParticipationAgreement:
          type: 
             - object
@@ -118,17 +207,19 @@ components:
             pdf:
                type: string
                description: Link to the PDF version of the participation agreement
+      
       WorkingGroupLevels:
          type: array
          items:
           $ref: '#/components/schemas/WorkingGroupLevel'
+          
       WorkingGroupLevel:
          type: object
          description: Definition of the participation level for the working group, including its relation code
          properties:
-           relation:
-              type: string
-              description: code representing the relation, used internally when using common relation types
-           description:
-              type: string
-              description: the label for the participation level
+            relation:
+               type: string
+               description: code representing the relation, used internally when using common relation types
+            description:
+               type: string
+               description: the label for the participation level