Merge pull request #216 from valens200/docs

chore(report): REST APIs week 1  & 2 report

Author: GMishx

docs/2024/index.md

@@ -20,10 +20,10 @@ More info to come here.
 
 ### Projects
 
-[//]: # (Following are the important links to projects.)
+[//]: # "Following are the important links to projects."
 
 | Contributor                                          | Project                                                      |
-|:-----------------------------------------------------|:-------------------------------------------------------------|
+| :--------------------------------------------------- | :----------------------------------------------------------- |
 | [Aaditya Singh](https://github.com/aadsingh)         | [Overhaul Scheduler Design](/docs/2024/scheduler)            |
 | [Abdelrahman Jamal](https://github.com/Hero2323)     | [AI Powered License Detection](/docs/2024/license-detection) |
 | [Abhishek Kumar](https://github.com/abhi-kumar17871) | [SPDX 3.0 Support](/docs/2024/spdx30)                        |
@@ -50,16 +50,16 @@ More info to come here.
 ### Meetings table
 
 | Topic(s)            | Timings                       | Meeting link                                                                                            | ICS                                  |
-|:--------------------|:------------------------------|:--------------------------------------------------------------------------------------------------------|:-------------------------------------|
-| General Meeting     | *Thursday* 13:30 - 14:30 UTC  | [Jitsi](https://meet.jit.si/moderated/5a655b3b6f3b4f83cddb13b93ac5408d6de48bf4ce1049f4128aa1c885478d48) | [.ics](/ics/gsoc_2024_weekly.ics)    |
+| :------------------ | :---------------------------- | :------------------------------------------------------------------------------------------------------ | :----------------------------------- |
+| General Meeting     | _Thursday_ 13:30 - 14:30 UTC  | [Jitsi](https://meet.jit.si/moderated/5a655b3b6f3b4f83cddb13b93ac5408d6de48bf4ce1049f4128aa1c885478d48) | [.ics](/ics/gsoc_2024_weekly.ics)    |
 | -                   | -                             | -                                                                                                       | -                                    |
-| SPDX Related        | *Tuesday* 10:30 - 11:20 UTC   | [Jitsi](https://moderated.jitsi.net/d623bb1284a54c83958eff31d2ecce9ed6b894312eda4ed9b400d5963f4e18b6)   | [.ics](/ics/gsoc_2024_spdx.ics)      |
-| REST API            | *Tuesday* 11:00 - 11:50 UTC   | [Jitsi](https://moderated.jitsi.net/d623bb1284a54c83958eff31d2ecce9ed6b894312eda4ed9b400d5963f4e18b6)   | [.ics](/ics/gsoc_2024_rest.ics)      |
-| CI Scanner          | *Wednesday* 10:30 - 11:00 UTC | [Jitsi](https://moderated.jitsi.net/39896aad61bc4a27b9418ee6b78689348c65790e889046069dbe9c8c34110c9a)   | [.ics](/ics/gsoc_2024_ci.ics)        |
-| Scheduler Overhaul  | *Friday* 10:30 - 11:00 UTC    | [Jitsi](https://moderated.jitsi.net/5444f675f5ce47c788fa4238a6a958c53d3e62804e9243d5b807fbaa81f3120f)   | [.ics](/ics/gsoc_2024_scheduler.ics) |
-| AI Powered Scanners | *Thursday* 10:30 - 11:20 UTC  | [Jitsi](https://moderated.jitsi.net/15ee0bf46cb345e4accc817ed2967b55db216bf57c894c30bd1550ecf3ec3ace)   | [.ics](/ics/gsoc_2024_ai.ics)        |
+| SPDX Related        | _Tuesday_ 10:30 - 11:20 UTC   | [Jitsi](https://moderated.jitsi.net/d623bb1284a54c83958eff31d2ecce9ed6b894312eda4ed9b400d5963f4e18b6)   | [.ics](/ics/gsoc_2024_spdx.ics)      |
+| CI Scanner          | _Wednesday_ 10:30 - 11:00 UTC | [Jitsi](https://moderated.jitsi.net/39896aad61bc4a27b9418ee6b78689348c65790e889046069dbe9c8c34110c9a)   | [.ics](/ics/gsoc_2024_ci.ics)        |
+| Scheduler Overhaul  | _Friday_ 10:30 - 11:00 UTC    | [Jitsi](https://moderated.jitsi.net/5444f675f5ce47c788fa4238a6a958c53d3e62804e9243d5b807fbaa81f3120f)   | [.ics](/ics/gsoc_2024_scheduler.ics) |
+| AI Powered Scanners | _Thursday_ 10:30 - 11:20 UTC  | [Jitsi](https://moderated.jitsi.net/15ee0bf46cb345e4accc817ed2967b55db216bf57c894c30bd1550ecf3ec3ace)   | [.ics](/ics/gsoc_2024_ai.ics)        |
 
 ### Photo
+
 Photos to come soon.
 
 Thanks for being part of the community. 💚

docs/2024/rest/index.md

@@ -3,28 +3,30 @@ sidebar_position: 1
 title: Introduction
 slug: /2024/rest/
 ---
+
 <!--
 SPDX-License-Identifier: CC-BY-SA-4.0
 
 SPDX-FileCopyrightText: 2024 Divij Sharma <divijs75@gmail.com>
 -->
 
-## Author
-
-[Divij Sharma](https://github.com/dvjsharma)
-
-## Contact info
+## Authors
 
-- [Email](mailto:divijs75@gmail.com)
-- [LinkedIn](https://linkedin.com/in/dvjsharma)
+- [Divij Sharma](https://github.com/dvjsharma)
+  - [Email](mailto:divijs75@gmail.com)
+  - [LinkedIn](https://linkedin.com/in/dvjsharma)
+- [Valens Niyonsenga](https://github.com/valens200)
+  - [Email](mailto:valensniyonsenga2003@gmail.com)
+  - [LinkedIn](https://www.linkedin.com/in/valens-niyonsenga-947440228/)
 
 ## Project title
 
 REST API Improvements
 
 ## What's the project about?
 
-In recent years, FOSSology's REST APIs have expanded significantly, enhancing user accessibility, flexibility, and automation. However, the development is not yet complete, prompting some users to resort to mocking WebUI access solely for information retrieval. With the development of FOSSology's new [React UI](https://github.com/fossology/FOSSologyUI) also underway, robust support for REST APIs becomes imperative. 
+In recent years, FOSSology's REST APIs have expanded significantly, enhancing user accessibility, flexibility, and automation. However, the development is not yet complete, prompting some users to resort to mocking WebUI access solely for information retrieval. With the development of FOSSology's new [React UI](https://github.com/fossology/FOSSologyUI) also underway, robust support for REST APIs becomes imperative.
+
 
 This project aims to finalize the development of FOSSology's REST API by exposing any remaining endpoints, enhancing and upgrading existing ones to V2, increasing test coverage, and improving documentation. The approach involves a comprehensive review of each module to ensure the availability and exposure of required APIs for frontend consumption. These efforts will streamline development workflows, enhancing the overall usability of the FOSSology platform and facilitating the development of the new React UI.
 
@@ -33,11 +35,22 @@ This project aims to finalize the development of FOSSology's REST API by exposin
 This project involves the following tasks:
 
 1. **Exposing New API Endpoints:**
+
    - Identify and expose any remaining endpoints required for frontend consumption.
    - Ensure that all endpoints are RESTful and adhere to the OpenAPI specification.
    - Update documentation to reflect the new endpoints and their usage.
 
 2. **Upgrading Existing Endpoints to Version 2:**
+
+   - Develop a REST API guideline which will provide a solid set of rules to follow.
+   - Upgrade existing endpoints to V2 based on the guideline, also ensuring backward compatibility.
+   - Update documentation to reflect the changes and versioning.
+
+3. **Increasing Test Coverage:**
+   - Study each endpoint and its functionality to identify potential edge cases.
+   - Write unit tests for all existing and new endpoints.
+
+More specific details about each task can be found in the [Task Details Table](https://docs.google.com/document/d/158BZBZ5owLtI-SqD1MIduMy4bR3XLuwm4aDLynoFZAA/edit?usp=sharing).
     - Develop a REST API guideline which will provide a solid set of rules to follow.
     - Upgrade existing endpoints to V2 based on the guideline, also ensuring backward compatibility.
     - Update documentation to reflect the changes and versioning.
@@ -46,4 +59,4 @@ This project involves the following tasks:
     - Study each endpoint and its functionality to identify potential edge cases.
     - Write unit tests for all existing and new endpoints.
 
-More specific details about each task can be found in the [Task Details Table](https://docs.google.com/document/d/158BZBZ5owLtI-SqD1MIduMy4bR3XLuwm4aDLynoFZAA/edit?usp=sharing).
+More specific details about each task can be found in the [Task Details Table](https://docs.google.com/document/d/158BZBZ5owLtI-SqD1MIduMy4bR3XLuwm4aDLynoFZAA/edit?usp=sharing).

docs/2024/rest/updates/_category_.json

@@ -0,0 +1,92 @@
+---
+title: Community bonding
+author: Divij Sharma
+---
+<!--
+SPDX-License-Identifier: CC-BY-SA-4.0
+
+SPDX-FileCopyright Text: 2024 Divij Sharma <divijs75@gmail.com>
+-->
+
+# Community Bonding
+
+## Introduction meeting
+
+*(May 7,2024)*
+
+This was the first meeting of the community bonding period for GSoC '24. Mentors and contributors introduced themselves, and the general meeting time and platform were decided.
+
+## Meeting 1
+
+*(May 9,2024)*
+
+This was the first general meeting after the introduction meeting. Mentors discussed the importance of communication and the need for regular updates. The contributors were free to ask any questions they had.
+
+## During community bonding week 1
+
+*(May 9,2024- May 15,2024)*
+
+### Activities
+
+* I created an unofficial communication group with fellow contributors to get to know each other better.
+* I discussed the project and the tasks that need to be completed during the coding period with the mentors.
+* I clarified some of my doubts regarding the project timeline.
+
+### Work done
+
+* I was already familiar with the code-base because of my previous contributions to FOSSology. I started working on upgrading the REST APIs to version 2.
+* I fixed some minor bugs in the following of my uplink PRs related to the upgradation:
+    - [feat(api): Upgrade User & Group APIs to Version 2 ](https://github.com/fossology/fossology/pull/2711)
+    - [feat(api): Upgrade Folder, License & Obligation APIs to Version 2](https://github.com/fossology/fossology/pull/2712)
+
+## Meeting 2
+
+*(May 16,2024)*
+
+We discussed the progress made during the first week of community bonding. Mentors asked if contributors were able to set up their development environments and if they faced any issues. Everyone gave a brief overview of the tasks they were working on.
+
+## During community bonding week 2
+
+*(May 16,2024- May 22,2024)*
+
+### Activities
+
+* I had calls with fellow contributors to help them set up their development environments.
+* I had a discussion with my colleague [Valens](https://github.com/valens200) about how we shall manage our tasks.
+
+### Work done
+
+* I continued working on upgrading the REST APIs to version 2.
+
+* I finalized the work on a new endpoint to retrieve user copyright findings and also upgraded Jobs and Report APIs to version 2.
+    - [feat(api): New endpoint to retrieve user copyright findings ](https://github.com/fossology/fossology/pull/2717)
+    - [feat(api): Upgrade Jobs and Report APIs to Version 2 ](https://github.com/fossology/fossology/pull/2736)
+
+
+## Meeting 3
+
+*(May 23,2024)*
+
+We discussed the progress made during the second week of the community bonding period. Mentors asked if contributors faced any issues while installing the project and encouraged us to make small contributions. We also decided on the time for project-specific weekly meetings.
+
+## During community bonding week 3
+
+*(May 23,2024- May 29,2024)*
+
+### Activities
+
+* I helped few of my colleagues in setting up their development environments.
+
+### Work done
+
+* I continued working on upgrading the REST APIs to version 2.
+
+* I upgraded the Search, Copyright & Admin APIs to Version 2.
+    - [feat(api): Upgrade Search, Copyright & Admin APIs to Version 2 ](https://github.com/fossology/fossology/pull/2744)
+
+## Meeting 4
+
+*(May 30,2024)*
+
+We discussed the progress made during the third week of the community bonding period. Mentors gave general updates followed by weekly updates by contributors. We had a session on how are we supposed to present and maintain our work during the coding period through the documentation.
+   

docs/2024/rest/updates/sharma/2024-05-07.md

@@ -0,0 +1,50 @@
+---
+title: Week 1
+author: Divij Sharma
+tags: [gsoc24, rest]
+---
+
+<!--
+SPDX-License-Identifier: CC-BY-SA-4.0
+
+SPDX-FileCopyrightText: 2024 Divij Sharma <divijs75@gmail.com>
+-->
+
+# Week 1 meeting and activities
+
+_(May 30,2024)_
+
+## Attendees:
+
+- [Divij Sharma](https://github.com/dvjsharma)
+- [Gaurav Mishra](https://github.com/GMishx)
+- [Samuel Dushimimana](https://github.com/dushimsam)
+- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
+- [Soham Banerjee](https://github.com/soham4abc)
+- [Valens Niyonsenga](https://github.com/valens200)
+
+## Discussion:
+
+- **Who should be doing what?**
+
+  - Discussed project responsibilities with my colleague [Valens](https://github.com/valens200) and mentors.
+  - We decided that currently I will focus on the REST API Version 2 upgrade and OAuth 2.0 implementation, while Valens would work on adding test cases for the current REST API implementation.
+
+- **REST API Version 2 updates**
+
+  - I mentioned that the work on the REST API Version 2 upgrade is almost complete and suggested we can start looking for any further improvements.
+  - Mentors suggested I should review the code and look for any possible improvements based on my proposed guidelines. [(REST API Guidelines)](../../API-guidelines.md).
+
+- **OAuth 2.0 architecture discussion and needs**
+  - [Gaurav](https://github.com/GMishx) explained the various modes of authentication we aim to have in the FOSSology project. These are:
+    - Token based authentication
+    - Authorization Code Grant (Web Application)
+    - Client Credentials Grant (Machine to Machine)
+  - I cleared my doubts regarding the OAuth 2.0 implementation and its significance in the project. I also got a rough vision of what needs to be implemented and what is already implemented. [(Reference Material)](https://github.com/fossology/fossology/wiki/OpenID-Connect-authentication-configuration)
+
+## Activities:
+
+- Tested the REST API Version 2 on a local instance and noted down the improvements that can be made.
+- Researched on OAuth 2.0 and how it can be implemented in the project.
+- Did minor improvements in the following PR:
+  - [feat(api): Upgrade User & Group APIs to Version 2 ](https://github.com/fossology/fossology/pull/2711)

docs/2024/rest/updates/sharma/2024-05-30.md

@@ -0,0 +1,51 @@
+---
+title: Week 2
+author: Divij Sharma
+tags: [gsoc24, rest]
+---
+<!--
+SPDX-License-Identifier: CC-BY-SA-4.0
+
+SPDX-FileCopyrightText: 2024 Divij Sharma <divijs75@gmail.com>
+-->
+
+# Week 2 meeting and activities
+
+*(June 6,2024)*
+
+## Attendees:
+
+- [Divij Sharma](https://github.com/dvjsharma)
+- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
+- [Valens Niyonsenga](https://github.com/valens200)
+
+## Discussion:
+
+  - No major updates since the last meeting.
+  - Discussed the improvements that can be made in the REST API Version 2.
+  - Discussed the implementation of OAuth 2.0 in the project.
+
+## Activities:
+
+- **OAuth 2.0**
+  - Researched OAuth 2.0 and its application on production servers. Found the [Auth0 article](https://auth0.com/intro-to-iam/what-is-oauth-2) particularly helpful. Studied various architectural patterns for different flows to determine the best fit for our project.
+  - Prepared a draft outlining the implementation details, focusing on two scenarios:
+
+    - **For the API**:
+      - Create an endpoint to add new clients, accepting `name`, `clientId`, and `scope`.
+      - Another endpoint to configure FOSSology, accepting `appName`, `clientId`, `clientSecret`, `clientClaim`, `redirectUri`, and `discoveryUri`. The `discoveryUri` will be used to fetch other required endpoints.
+      - Once these steps are completed, FOSSology will be configured to use OAuth 2.0. Users can obtain a token from their authorization server to access the FOSSology API.
+
+    - **For the Web Application**:
+      - Implement the Authorization Code Grant flow for the frontend. This requires a login page where users can log in and receive a code, which can be exchanged for a token to access the FOSSology API.
+      - Researched libraries to implement this flow on the frontend.
+      - On the server side, implement a mechanism to verify user credentials received from the server and issue a token to the user.
+
+- **REST API Version 2**
+  - Reviewed the code and identified areas for improvement.
+  - Found the following things which we can look into:
+    - Status Codes: Particularly 204 (no content)
+    - Adding pagination to all necessary endpoints
+    - Using model classes for all major/minor responses
+    - Test coverage
+    - Authentication workflow

docs/2024/rest/updates/sharma/2024-06-06.md

@@ -0,0 +1,4 @@
+{
+  "label": "Divij Sharma",
+  "position": 2
+}

docs/2024/rest/updates/sharma/_category_.json

@@ -0,0 +1,46 @@
+---
+title: Community bonding
+author: Valens Niyonsenga
+---
+
+<!--
+SPDX-License-Identifier: CC-BY-SA-4.0
+
+SPDX-FileCopyright Text: 2024 Valens Niyonsenga <valensniyonsenga2003@gmail.com@gmail.com>
+-->
+
+# Community Bonding
+
+## Introduction meeting
+
+_(May 7,2024)_
+
+We had the introductory meeting opening the community bonding for GSoC'24. All members, including mentors and contributors, introduced themselves and discussed more about the general meeting time and platform decision.
+
+## Meeting 1
+
+_(May 9,2024)_
+
+After introductory meetinThis was our initial general meeting following the introductory session. The mentors emphasized the significance of maintaining communication and providing updates. Contributors were encouraged to ask any questions they had.
+
+## During community bonding week 1
+
+_(May 12,2024- May 18,2024)_
+
+### Activities
+
+- Discussed with mentors more about the project and the tasks that need to be completed.
+- Got in touch with fellow contributors, sharing ideas on how we were going to approach our respective projects.
+
+### Work done
+
+- I set up the project's development environment.
+- Cleared some doubts and asked questions to understand the project better..
+
+## Meeting 2
+
+_(May 30,2024)_
+
+- Mentors asked for any updates from contributors.
+- Mentors asked to update the documentation tool before joining the next call.
+- Mentors explained about the GSoC tool documentation tool, different rules for the code, and documentation.

docs/2024/rest/updates/valens/2024-05-07.md

@@ -0,0 +1,32 @@
+---
+title: Week 1
+author: Valens Niyonsenga
+tags: [gsoc24, rest]
+---
+
+<!--
+SPDX-License-Identifier: CC-BY-SA-4.0
+
+SPDX-FileCopyrightText: 2024 Valens Niyonsenga <valensniyonsenga2003@gmail.com>
+-->
+
+# Week 1 meeting and activities
+
+_(May 30,2024)_
+
+## Attendees:
+
+- [Valens Niyonsenga](https://github.com/valens200)
+- [Gaurav Mishra](https://github.com/GMishx)
+- [Samuel Dushimimana](https://github.com/dushimsam)
+- [Shaheem Azmal M MD](https://github.com/shaheemazmalmmd)
+- [Soham Banerjee](https://github.com/soham4abc)
+- [Divij Sharma](https://github.com/dvjsharma)
+
+## Discussion:
+
+- **Who should be doing what?**
+
+  - I had discussion with mentors and my colleague [Divij Sharma](https://github.com/dvjsharma).
+  - Divided responsibilities with my colleague [Divij Sharma](https://github.com/dvjsharma).
+  - We took a decision that I will be focusing on adding test cases for the current REST API implementation while Sharma would focus on REST API version 2 upgrade and OAuth 2.0 implementation.