Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Add `required` contraints to schema objects

Open
  • Is something wrong?
#223 3 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
52/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Quiet
Tech stack
openapi
Domain
api

Research direction

Locate the OpenAPI schema definitions for identifier, collection, collection-update-reason, artifact, checksum, and component-release. Review which significant fields should be required and remove required entries that have no matching property. Done means the affected schemas consistently declare valid required properties.

Written by the indexing model from the issue text.

Description

Prio 2

Many schema objects in the OpenAPI specification do not define required constraints for their most significant fields. Examples include identifier, collection, collection-update-reason, artifact, and checksum.

Additionally, some schemas declare required properties that do not exist, such as in component-release.

Dominant language
Shell
Stars
120
Forks
24
Avg merge
1d 6h
Merged PRs (30d)
67

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from CycloneDX/transparency-exchange-api

All issues in CycloneDX/transparency-exchange-api

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.