Skip to content

Commit

Permalink
deprecate cdx:poetry:package:source:... in favor of `cdx:python:pac…
Browse files Browse the repository at this point in the history
…kage:source:...` (#98)

Signed-off-by: Jan Kowalleck <jan.kowalleck@owasp.org>
  • Loading branch information
jkowalleck authored Sep 19, 2024
1 parent 296fbbd commit e8553fd
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions cdx/poetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,28 @@

| Namespace | Description |
|-----------|-------------|
| `cdx:poetry:package:source` | Namespace for package-source specific properties. |
| `cdx:poetry:package:source` | **Deprecated** namespace for package-source specific properties. |

## `cdx:poetry:package:source` Namespace Taxonomy

This namespace is **deprecated** in favor of the more general [`cdx:python:package:source`](./python.md).

| Property | Description |
|----------|-------------|
| `cdx:poetry:package:source:reference` | The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:resolved_reference` | The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:reference` | **Deprecated** in favor of the more general [`cdx:python:package:source:vcs:requested_revision`](./python.md). <br/> The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:resolved_reference` | **Deprecated** in favor of the more general [`cdx:python:package:source:vcs:commit_id`](./python.md). <br/> The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |

| Namespace | Description |
|-----------|-------------|
| `cdx:poetry:package:source:vcs` | **DEPRECATED** namespace for package-source's VCS specific properties. |

## `cdx:poetry:package:source:vcs` Namespace Taxonomy

This namespace is **deprecated** in favor of the more general [`cdx:python:package:source:vcs`](./python.md), or consider the properties mentioned above.
This namespace is **deprecated** in favor of the more general [`cdx:python:package:source:vcs`](./python.md).

| Property | Description |
|----------|-------------|
| `cdx:poetry:package:source:vcs:requested_revision` | The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:vcs:commit_id` | The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:vcs:requested_revision` | **Deprecated** in favor of the more general [`cdx:python:package:source:vcs:requested_revision`](./python.md). <br/> The repository reference of this package, e.g. "master", "1.0.0" or a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |
| `cdx:poetry:package:source:vcs:commit_id` | **Deprecated** in favor of the more general [`cdx:python:package:source:vcs:commit_id`](./python.md). <br/> The resolved repository reference of this package, e.g. a commit hash for git. Values may be applied to [`externalReferences`][CDX-useCases-externalReferences] of type `vcs`. _Non-empty string value_. May appear once. |

[CDX-useCases-externalReferences]: https://cyclonedx.org/use-cases/#external-references

0 comments on commit e8553fd

Please sign in to comment.