Skip to content

[docs]:update entity supported fields to edit #176

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs]:update entity supported fields to edit #176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 24 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,43 +300,33 @@ We support the following modifications operations

`Document`

| Input Param | Input Format | CDX Spec Field | SPDX Spec field |
|----------|----------|----------| -----------------------------|
| author | "name (email)" | Metadata->authors | CreationInfo->Creator->Person|
| supplier | "name (url)" | Metadata->Supplier | CreationInfo->Creator->Comment |
| tool | "name (version)" | Metadata->Tools | CreationInfo->Creator->Tool |
| lifecycle | "build" | Metadata->lifecycles->phase | - |
| type | "application" | - | - |
| name | "name" | - | - |
| version | "1.0.0" | - | - |
| description | "description" | - | DocumentComment |
| copyright| "abc @2023" | - | - |
| repository | "github.com/interlynk/sbomasm"| bom->externalreferences | - |
| cpe | "cpe:2.3:a:apache:tomcat:9.0.0:*:*:*:*:*:*:*" | - | - |
| purl| "pkg:github/apache/tomcat@9.0.0" | - | - |
| hash | "MD5 (1234567890)" | - | - |
| license | "MIT (mit.edu/~amini/LICENSE.md)" | Metadata->Licenses | DataLicense |
| timestamp | "2023-05-03T04:49:33.378-0700" | Metadata->timestamp | CreationInfo->Created |
| Input Param | Input Format | CDX Spec Field | SPDX Spec field | Examples |
|----------|----------|----------| -----------------------------| -------------- |
| author | "name (email)" | Metadata->authors | CreationInfo->Creator->Person| `--author "foo (foo@gmail.com)"` |
| supplier | "name (url)" | Metadata->Supplier | CreationInfo->Creator->Comment | `--supplier "foo (https://foo.com)"` |
| tool | "name (version)" | Metadata->Tools | CreationInfo->Creator->Tool | `--tool "foo (v1.0.0)"` |
| lifecycle | "build" | Metadata->lifecycles->phase | N/A | `--lifecycle "build"` |
| description | "description" | N/A | DocumentComment | `--description "hey, i am foo"` |
| repository | "github.com/interlynk/sbomasm"| bom->externalreferences | N/A | `--repository "github.com/foo/foo"` |
| license | "MIT (mit.edu/~amini/LICENSE.md)" | Metadata->Licenses | DataLicense | `--license "CC0-1.0"` |
| timestamp | "2023-05-03T04:49:33.378-0700" | Metadata->timestamp | CreationInfo->Created | it auto updated |

`Primary Component & Component Name Version`

| Input Param | Input Format | CDX Spec Field | SPDX Spec field |
|----------|----------|----------| -----------------------------|
| author | "name (email)" | Comp->authors or author | - |
| supplier | "name (url)" | Comp->Supplier | Pkg->Supplier |
| tool | "name (version)" | - | - |
| lifecycle | "build" | - | - |
| type | "application" | Comp->Type | Pkg->PrimaryPackagePurpose |
| name | "name" | Comp->name | Pkg->PackageName |
| version | "1.0.0" | Comp->version | Pkg->PackageVersion |
| description | "description" | Comp->Description | Pkg->PackageDescription |
| copyright| "abc @2023" | Comp->copyright | pkg->copyright |
| repository | "github.com/interlynk/sbomasm"| Comp->externalreferences | Pkg->PackageDownloadLocation |
| cpe | "cpe:2.3:a:apache:tomcat:9.0.0:*:*:*:*:*:*:*" | Comp->cpe | Pkg->ExternalReferences->Security |
| purl| "pkg:github/apache/tomcat@9.0.0" | Comp->purl | Pkg->ExternalReferences->PackageManager |
| hash | "MD5 (1234567890)" | Comp->hashes | Pkg->Checksums |
| license | "MIT (mit.edu/~amini/LICENSE.md)" | Comp->Licenses | Pkg->ConcludedLicense |
| timestamp | "2023-05-03T04:49:33.378-0700" | - | - |
| Input Param | Input Format | CDX Spec Field | SPDX Spec field | Examples |
|----------|----------|----------| -----------------------------| --------------|
| author | "name (email)" | Comp->authors or author | N/A | `--author "bar bar@gmail.com"`|
| supplier | "name (url)" | Comp->Supplier | Pkg->Supplier | `--supplier "bar (https://bar.com)"` |
| type | "application" | Comp->Type | Pkg->PrimaryPackagePurpose | `--type "application"` |
| name | "name" | Comp->name | Pkg->PackageName | `--name "tablewriter-bar"` |
| version | "1.0.0" | Comp->version | Pkg->PackageVersion | `--version "v1.0.5"` |
| description | "description" | Comp->Description | Pkg->PackageDescription | `--description "hey, this bar"` |
| copyright| "abc @2023" | Comp->copyright | pkg->copyright | `--copyright "bar@2030"` |
| repository | "github.com/interlynk/sbomasm"| Comp->externalreferences | Pkg->PackageDownloadLocation | `--repository "github.com/bar/bar"` |
| cpe | "cpe:2.3:a:apache:tomcat:9.0.0:*:*:*:*:*:*:*" | Comp->cpe | Pkg->ExternalReferences->Security | `--cpe "cpe:2.3:a:bar:tablewriter:v0.0.5:*:*:*:*:*:*:*"` |
| purl| "pkg:github/apache/tomcat@9.0.0" | Comp->purl | Pkg->ExternalReferences->PackageManager | `--purl "pkg:github/bar/bar@0.0.0"` |
| hash | "MD5 (1234567890)" | Comp->hashes | Pkg->Checksums | `--hash "MD5 (3f619af370f7e308b5a3d27a5a1d6646ea9de26)"` |
| license | "MIT (mit.edu/~amini/LICENSE.md)" | Comp->Licenses | Pkg->ConcludedLicense | `--license "MIT"` |

## Searching for a component

Expand Down