Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend demo project schema attribute to allow multiple URLs #778

Closed
arkid15r opened this issue Feb 8, 2025 · 12 comments · Fixed by #892
Closed

Extend demo project schema attribute to allow multiple URLs #778

arkid15r opened this issue Feb 8, 2025 · 12 comments · Fixed by #892
Assignees
Labels
good first issue Good for newcomers schema

Comments

@arkid15r
Copy link
Collaborator

arkid15r commented Feb 8, 2025

Describe the solution you'd like
Extend demo schema from string to an array. Keep it still optional but if present it must contain at least 1 item.

@arkid15r arkid15r added good first issue Good for newcomers schema labels Feb 8, 2025
@github-project-automation github-project-automation bot moved this to Backlog in Project Nest Feb 8, 2025
@arkid15r arkid15r moved this from Backlog to Todo in Project Nest Feb 8, 2025
@Raghavg18
Copy link
Contributor

@arkid15r Can u assign it to me?

@arkid15r
Copy link
Collaborator Author

arkid15r commented Feb 8, 2025

@arkid15r Can u assign it to me?

Please finish #749 first.

@Rushhaabhhh
Copy link
Collaborator

@arkid15r Can I please take this issue ? I would bring out a solution soon.

@arkid15r
Copy link
Collaborator Author

arkid15r commented Feb 8, 2025

@Rushhaabhhh you qualify for the good first issue (1-3 PRs) at this time 👍

@arkid15r arkid15r moved this from Todo to In progress in Project Nest Feb 8, 2025
@arkid15r arkid15r added this to the OWASP Schema 🗂️ milestone Feb 9, 2025
@YourBroCode
Copy link
Contributor

@arkid15r please assign this issue to me.

@arkid15r
Copy link
Collaborator Author

@arkid15r please assign this issue to me.

The good first issues are for newcomers only.

@YourBroCode
Copy link
Contributor

Okay, Actually you mentioned this issue for me in the slack. that's why i commented.

@arkid15r
Copy link
Collaborator Author

Okay, Actually you mentioned this issue for me in the slack. that's why i commented.

I don't see who has how many contribution in Slack, sorry 🤷‍♂

@priyankaChauhan2804
Copy link
Contributor

could i work on this issue?

@moodyadi2006
Copy link
Contributor

moodyadi2006 commented Feb 16, 2025

Approach for Implementing demo Field in the Project Schema

Objective

Enhance the project schema by adding an optional demo field to store project demonstration URLs. This will allow users to provide live previews, hosted service links, or video demonstrations of their projects.

Proposed Schema Update

The demo field will be an optional array of unique URLs.

Updated Schema Definition:

"demo": {
  "description": "Optional URLs to project demos.",
  "type": "array",
  "items": {
    "type": "string",
    "format": "uri"
  },
  "minItems": 1,
  "uniqueItems": true
}

Implementation Plan

  1. Schema Modification

    • I will Update the project.json schema to include the demo field.
    • Ensure that each item in the array is a properly formatted URL (format: uri).
    • Set minItems: 1 to enforce that at least one demo URL is provided if the field is used.
    • Enforce uniqueItems: true to prevent duplicate entries.
  2. Testing

    • Unit tests for schema validation.
    • Integration tests to ensure API handles the demo field correctly.

Expected Outcome

  • Users can provide one or more demonstration links for their projects.
  • Improves discoverability and usability of project showcases.
  • Ensures structured, validated, and unique URLs in the dataset.

Let me know if any modifications are needed. Looking forward to your feedback!
@arkid15r Can you assign this issue to me?

@Krishnaag23
Copy link

could I work on this issue? @arkid15r

@Raghavg18
Copy link
Contributor

Hey @arkid15r i finished #749 now can u assign this to me?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment