theupdateframework / theupdateframework/specification

It would be nice to have an OpenAPI or JSON Schema for TUF resource types

Open
#242 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
405
Forks
59
Avg merge
3d 4h
Merged PRs (30d)
1

Description

While building Sigstore TUF clients it's necessary to parse the various resource types (Root, Snapshot, Target,..). Most languages have serialization tools that can do this automatically with the right OpenAPI or Json Schema docs. Making these available could accelerate client development.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the specification definitions for the Root, Snapshot, and Target resource types mentioned in the issue, then determine the complete set of TUF resource types that needs coverage. Done means usable OpenAPI or JSON Schema documents are available for serialization-oriented client development.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, openapi
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.