Skip to content

Add Schema that defines PURL types #401

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.

Sign up for GitHub

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

Jump to bottom
Closed
stevespringett wants to merge 119 commits into from
Closed

Add Schema that defines PURL types #401

stevespringett wants to merge 119 commits into from

Conversation

@stevespringett
Copy link
Member

@stevespringett stevespringett commented Mar 1, 2025 •
edited
Loading

This PR adds a formal structure to PURL type definitions. This PR contains:

  • JSON schema for PURL type definitions
  • JSON schema for the index of all PURL type definitions
  • Sample PURL type definitions (e.g. maven, npm, etc)
  • GitHub action and Python script that will automatically generate:
    • The index.json of all PURL type definitions
    • The human-readable documentation for all types in Markdown format

This PR closes #310

@stevespringett
Initial check-in of purl type definition support
b65812b 
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett
Added index and doc generation
d5d170e 
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett
Removed description from index and added note to all docs
4e5ae33 
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett
Updated Maven definition
532f7d2 
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett
Simplified case normalization
d13aefd 
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett
Added npm definition
950dc67 
Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett
Added auto-generated files - these will be overwritten once the GitHu…
aa5fb80 
…b action is activated.

Signed-off-by: Steve Springett <steve@springett.us>
@stevespringett stevespringett changed the title Purl type schema Add Schema that defines PURL types Mar 1, 2025
@stevespringett
Added SWID definition
59347ce 
Signed-off-by: Steve Springett <steve@springett.us>
Dustin4444
Dustin4444 previously approved these changes Mar 2, 2025
View reviewed changes
matt-phylum
matt-phylum reviewed Mar 3, 2025
View reviewed changes
@johnmhoran johnmhoran added PURL type definition Non-core definitions that describe and standardize PURL types documentation Ecma PURL component: type PURL generation labels Mar 4, 2025
@pombredanne pombredanne dismissed Dustin4444’s stale review March 5, 2025 16:19

Unknown user, no comments. Looks like spam

@johnmhoran johnmhoran added this to the 1.0-draft milestone Apr 4, 2025
@johnmhoran johnmhoran added Ecma standard Part of the Ecma standard for PURL 1 high priority and removed Ecma labels May 28, 2025
@pombredanne pombredanne mentioned this pull request Jun 26, 2025
Closed
@pombredanne
Change README files case
e1833aa 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Remove description from the index
305664c 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Remove URL from index.
254c0b3 
We only need a list of types and I find it less brittle avoiding to
hardcode URLs.

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
pombredanne added 24 commits July 14, 2025 14:35
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
3f2e740 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: create types/oci-definition.json

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
313b572 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: create types/pub-definition.json

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
9549345 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: create types/pypi-definition.json

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
2f70e7a 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: create types/rpm-definition.json

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
3bb254a 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: create types/swid-definition.json

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
afea29d 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: create types/swift-definition.json

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
* Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definit…
7a9b8bd 
…ion.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: keep PURL-TYPES.rst

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
* Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definit…
b494f98 
…ion.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history: merge
@pombredanne
Copy PURL-TYPES.rst to types/alpm-definition.json types/apk-definitio…
655459f 
…n.json types/bitbucket-definition.json types/bitnami-definition.json types/cocoapods-definition.json types/cargo-definition.json types/composer-definition.json types/conan-definition.json types/conda-definition.json types/cpan-definition.json types/cran-definition.json types/deb-definition.json types/docker-definition.json types/gem-definition.json types/generic-definition.json types/github-definition.json types/golang-definition.json types/hackage-definition.json types/hex-definition.json types/huggingface-definition.json types/luarocks-definition.json types/maven-definition.json types/mlflow-definition.json types/npm-definition.json types/nuget-definition.json types/qpkg-definition.json types/oci-definition.json types/pub-definition.json types/pypi-definition.json types/rpm-definition.json types/swid-definition.json types/swift-definition.json keep history

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Remove definitions not specific to a type
1d6931e 
The files are still in rest format for now until we convert them to
proper JSON

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Add script to split files
9d7251a 
This is a script that takes one source file and multiple target files
as arguments and does a copy, keeping original commit history in a way
that git will be able to apply its heuristics to provide a proper
line-level blame

Written-by: @davidjsherman
Reference: https://gitlab.inria.fr/-/snippets/520
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Clarify that a repository url is for the default
cfd4c01 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Move repository 1st
5c9c5d5 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Add formatted type defs
46a7b7a 
These are for the three initial tests: maven, npm and swid

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Remove double backticks
a8f542b 
Replace with single

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Format JSON test files
aa1f697 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Remove older test files
3215796 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Use note and description consistently
615e5a6 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Focus checks and gen on subset of valid JSON types
d8a1cf4 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Ignore dev cache
4968f6a 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Complete type def conversion to JSON
e1ab37a 
All definitions are now valid JSON, but may be not vliad schema yet.

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Make all type def schema valid
8656191 
Also update the schema as needed

Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Generate all docs
39c34e5 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Rename is_case_sensitive to case_sensitive
c497de2 
Signed-off-by: Philippe Ombredanne <pombredanne@aboutcode.org>
@pombredanne
Copy link
Member

pombredanne commented Jul 25, 2025

I am closing this now in favor of this other PR that builds on top of this:

@pombredanne pombredanne deleted the purl_type_schema branch July 29, 2025 12:41
@johnmhoran johnmhoran mentioned this pull request Aug 1, 2025
Closed
This was referenced Oct 5, 2025
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pombredanne pombredanne pombredanne left review comments

@mjherzog mjherzog mjherzog left review comments

@mrutkows mrutkows mrutkows left review comments

+2 more reviewers

@matt-phylum matt-phylum matt-phylum left review comments

@Dustin4444 Dustin4444 Dustin4444 left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

1 high priority documentation Ecma standard Part of the Ecma standard for PURL PURL component: type PURL generation PURL type definition Non-core definitions that describe and standardize PURL types

Projects

None yet

Milestone

PURL Ecma-Standard v1.0

Development

Successfully merging this pull request may close these issues.

Proposal: Solution for Purl Type Definitions

8 participants

@stevespringett @pombredanne @mjherzog @mrutkows @matt-phylum @Dustin4444 @johnmhoran