Skip to content

feature: opds api endtpoint added#20

Open
faridy-mahvish wants to merge 1 commit into
RESPECTify-mainfrom
opds-api-endpoint
Open

feature: opds api endtpoint added#20
faridy-mahvish wants to merge 1 commit into
RESPECTify-mainfrom
opds-api-endpoint

Conversation

@faridy-mahvish

@faridy-mahvish faridy-mahvish commented Feb 26, 2026

Copy link
Copy Markdown

Description


This pull request integrates OPDS API endpoints into the server, allowing the application to serve a structured catalog of digital content. It establishes new routes for accessing a main manifest, the primary OPDS feed, and detailed information for various forms and groups.

@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @faridy-mahvish, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request integrates OPDS API endpoints into the server, allowing the application to serve a structured catalog of digital content. It establishes new routes for accessing a main manifest, the primary OPDS feed, and detailed information for various forms and groups, all served as static JSON files. This enhancement facilitates content discovery and distribution in a standardized format.

Highlights

  • New OPDS API Endpoints: Introduced several new API endpoints to serve OPDS (Open Publication Distribution System) related JSON and image files, enabling standardized distribution of digital content.
  • Static OPDS Content: Added a new manifest.json file, a main opds.json feed, and numerous individual JSON files for various forms and groups under the server/public/opds/forms and server/public/opds/groups directories.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • server/public/manifest.json
    • Added a new manifest file for the Tangerine application.
  • server/public/opds.json
    • Added a new OPDS feed file listing Tangerine groups.
  • server/public/opds/forms/change-location-of-case.json
    • Added a new OPDS form definition for "Change Location of Case".
  • server/public/opds/forms/create-an-urgent-notification.json
    • Added a new OPDS form definition for "Create an Urgent Notification".
  • server/public/opds/forms/dynamically-make-an-optional-form-required.json
    • Added a new OPDS form definition for "Dynamically Make an Optional Form Required".
  • server/public/opds/forms/form-084e1483-c69d-4566-af6d-1757c356a3d5.json
    • Added a new OPDS form definition for "Address_Form".
  • server/public/opds/forms/form-187e10c4-d783-43e7-a36d-5cd7f4a6127f.json
    • Added a new OPDS form definition for "Color_Of_Sky".
  • server/public/opds/forms/form-1d6d136a-6d66-4af5-a302-d7dea7998b2d.json
    • Added a new OPDS form definition for "test_form_1".
  • server/public/opds/forms/form-26870b14-1ca1-4335-9ff6-05b2a405a677.json
    • Added a new OPDS form definition for "Student_details".
  • server/public/opds/forms/form-510b038a-2c8a-432c-a23d-a326e3e2fce1.json
    • Added a new OPDS form definition for "Hospital_Form".
  • server/public/opds/forms/form-5cbd9a44-c996-4795-8c50-9c2240036fcd.json
    • Added a new OPDS form definition for "New_Form_1".
  • server/public/opds/forms/form-681d8518-61b0-4fe8-844f-e52c4954b68e.json
    • Added a new OPDS form definition for "Address_Form".
  • server/public/opds/forms/form-a4d83d1e-a9bb-4860-8f05-f62873d791de.json
    • Added a new OPDS form definition for "Mobile_Device".
  • server/public/opds/forms/form-a720911e-0e7d-40dc-b711-882495b83605.json
    • Added a new OPDS form definition for "Mountain".
  • server/public/opds/forms/form-bc263bb2-f4c8-47b8-9f19-de94ad12d28c.json
    • Added a new OPDS form definition for "user_age".
  • server/public/opds/forms/form-c0bdb7e2-2f7e-4a16-ad44-7ff9c1cfda7c.json
    • Added a new OPDS form definition for "XAPI-FORM".
  • server/public/opds/forms/form-c444c8bc-74be-407a-85fe-a808dc251ac6.json
    • Added a new OPDS form definition for "New_Form".
  • server/public/opds/forms/form-c58b9083-6112-4ed2-9a94-c518b5bc812c.json
    • Added a new OPDS form definition for "User_Details".
  • server/public/opds/forms/form-d901bd83-97c2-463a-bfd2-a82b4c76cd67.json
    • Added a new OPDS form definition for "test_form_02".
  • server/public/opds/forms/form-d9f1a8eb-4fc8-4fdf-ab86-89da234c4f8c.json
    • Added a new OPDS form definition for "Book_details".
  • server/public/opds/forms/form-df5d1cdd-6d2a-4373-944d-7d2367d59491.json
    • Added a new OPDS form definition for "New_Form".
  • server/public/opds/forms/form-that-syncs-up-but-not-down.json
    • Added a new OPDS form definition for "A_form_that_syncs_up_but_not_down".
  • server/public/opds/forms/kitchen-sink-form.json
    • Added a new OPDS form definition for "Kitchen_Sink_Form".
  • server/public/opds/forms/mark-form-as-required-example--form-1.json
    • Added a new OPDS form definition for "Mark_a_Form_as_required_example_form_1".
  • server/public/opds/forms/registration-role-1.json
    • Added a new OPDS form definition for "Role_1_Registration".
  • server/public/opds/forms/registration-role-2.json
    • Added a new OPDS form definition for "Role_2_Registration".
  • server/public/opds/forms/resolve-an-urgent-notification.json
    • Added a new OPDS form definition for "Data_Collector_resolves_urgent_notification".
  • server/public/opds/forms/test-form.json
    • Added a new OPDS form definition for "Test_Form".
  • server/public/opds/forms/test-issues-created-on-client.json
    • Added a new OPDS form definition for "Test_Issues_created_on_Client".
  • server/public/opds/forms/test-issues-created-programatically-on-client.json
    • Added a new OPDS form definition for "Test_Issues_created_programatically_on_Client".
  • server/public/opds/forms/workflow-form-1.json
    • Added a new OPDS form definition for "First_form_in_a_workflow".
  • server/public/opds/forms/workflow-form-2.json
    • Added a new OPDS form definition for "Second_form_in_a_workflow".
  • server/public/opds/forms/workflow-form-3.json
    • Added a new OPDS form definition for "Third_form_in_a_workflow".
  • server/public/opds/groups/group-06ee66ca-8528-42d7-9dca-c6172dae04af.json
    • Added a new OPDS group definition for "Group Z".
  • server/public/opds/groups/group-08449606-ed52-47c1-8464-2e9b67895af1.json
    • Added a new OPDS group definition for "Test".
  • server/public/opds/groups/group-291dd746-57de-443f-b0a5-49395b00937e.json
    • Added a new OPDS group definition for "Empty Group Test".
  • server/public/opds/groups/group-2923ef2a-9ab1-4509-b0c7-9ec8f2194a3f.json
    • Added a new OPDS group definition for "test001".
  • server/public/opds/groups/group-2cfa3662-f2bc-4a7e-b5cd-738a11815d09.json
    • Added a new OPDS group definition for "Group c".
  • server/public/opds/groups/group-5365bd80-f722-4eea-a59f-23ec8c9bbf77.json
    • Added a new OPDS group definition for "Group E".
  • server/public/opds/groups/group-59b1d482-0a67-4d3b-8fb6-e1e9db53ab30.json
    • Added a new OPDS group definition for "Group B".
  • server/public/opds/groups/group-8e26a43d-2a10-4afa-8563-0d70e54dbbbf.json
    • Added a new OPDS group definition for "Prayag's Group".
  • server/public/opds/groups/group-a2798239-0ec6-4556-9579-c8fe4adc77a9.json
    • Added a new OPDS group definition for "New Group A".
  • server/public/opds/groups/group-af1e2993-6112-4afa-be62-f5468eb3d93c.json
    • Added a new OPDS group definition for "Group M".
  • server/public/opds/groups/group-e5c2519e-70dc-4b2a-a276-a1272b89f7d6.json
    • Added a new OPDS group definition for "Group G".
  • server/public/opds/groups/group-f1245438-c0ce-4dc0-865a-abaa16dede3c.json
    • Added a new OPDS group definition for "Group D".
  • server/src/express-app.js
    • Added new API endpoints to serve OPDS manifest, main feed, group, form, and icon files.
Activity
  • The pull request was created by faridy-mahvish, introducing new OPDS API endpoints and static content.
  • The PR description uses a template, indicating standard procedure for new features.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces new OPDS API endpoints and a large number of static JSON files to serve as data for these endpoints. My review identified a few issues. Most critically, the new endpoints in express-app.js have path traversal vulnerabilities that must be fixed. Additionally, many of the new JSON files contain malformed URLs with double slashes, and one group file has an incorrect link. I've also pointed out a minor formatting issue. Please address these points to improve the security and correctness of the new feature. Also, there's a small typo in the pull request title ('endtpoint' should be 'endpoint').

"links": [
{
"rel": "self",
"href": "https://tangerinestaging.ustadmobile.com//opds/forms/create-an-urgent-notification.json",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The URL in the href field contains a double slash (//). While most clients handle this gracefully, it's technically incorrect and could cause issues with some parsers or servers. This issue appears in many of the newly added form JSON files. Please correct it everywhere it occurs.

Suggested change
"href": "https://tangerinestaging.ustadmobile.com//opds/forms/create-an-urgent-notification.json",
"href": "https://tangerinestaging.ustadmobile.com/opds/forms/create-an-urgent-notification.json",

"type": "application/json"
},
{
"href": "https://tangerinestaging.ustadmobile.com/releases/prod/online-survey-apps/group-a2798239-0ec6-4556-9579-c8fe4adc77a9/create-an-urgent-notification/assets//translation.en.json",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The URL in the href field for this resource contains a double slash (//). This should be corrected. This issue seems to be present in many of the newly added form JSON files in the resources array for the translation.en.json file. Please fix this across all relevant files.

Suggested change
"href": "https://tangerinestaging.ustadmobile.com/releases/prod/online-survey-apps/group-a2798239-0ec6-4556-9579-c8fe4adc77a9/create-an-urgent-notification/assets//translation.en.json",
"href": "https://tangerinestaging.ustadmobile.com/releases/prod/online-survey-apps/group-a2798239-0ec6-4556-9579-c8fe4adc77a9/create-an-urgent-notification/assets/translation.en.json",

"links": [
{
"rel": "self",
"href": "https://tangerinestaging.ustadmobile.com/forms/form-26870b14-1ca1-4335-9ff6-05b2a405a677.json",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The URL for this link is missing the /opds/ path segment. The endpoint defined in express-app.js for forms is /opds/forms/:formId. Please update the URL to be correct.

Suggested change
"href": "https://tangerinestaging.ustadmobile.com/forms/form-26870b14-1ca1-4335-9ff6-05b2a405a677.json",
"href": "https://tangerinestaging.ustadmobile.com/opds/forms/form-26870b14-1ca1-4335-9ff6-05b2a405a677.json",

@chimple chimple deleted a comment from gemini-code-assist Bot Feb 26, 2026
@chimple chimple deleted a comment from gemini-code-assist Bot Feb 26, 2026
@chimple chimple deleted a comment from gemini-code-assist Bot Feb 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant