Skip to content

Commit ea627ec

Browse files
authored
docs: update linked XML spec (#857)
Signed-off-by: Jan Kowalleck <[email protected]>
1 parent d801c2c commit ea627ec

File tree

10 files changed

+48
-48
lines changed

10 files changed

+48
-48
lines changed

cyclonedx/model/__init__.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ class Encoding(str, Enum):
157157
This is our internal representation of the encoding simple type within the CycloneDX standard.
158158
159159
.. note::
160-
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_encoding
160+
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/xml/#type_encoding
161161
"""
162162
BASE_64 = 'base64'
163163

@@ -168,7 +168,7 @@ class AttachedText:
168168
This is our internal representation of the `attachedTextType` complex type within the CycloneDX standard.
169169
170170
.. note::
171-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_attachedTextType
171+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_attachedTextType
172172
"""
173173

174174
DEFAULT_CONTENT_TYPE = 'text/plain'
@@ -261,7 +261,7 @@ class HashAlgorithm(str, Enum):
261261
This is our internal representation of the hashAlg simple type within the CycloneDX standard.
262262
263263
.. note::
264-
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/#type_hashAlg
264+
See the CycloneDX Schema: https://cyclonedx.org/docs/1.6/xml/#type_hashAlg
265265
"""
266266
# see `_HashTypeRepositorySerializationHelper.__CASES` for view/case map
267267
BLAKE2B_256 = 'BLAKE2b-256' # Only supported in >= 1.2
@@ -384,7 +384,7 @@ class HashType:
384384
This is our internal representation of the hashType complex type within the CycloneDX standard.
385385
386386
.. note::
387-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_hashType
387+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_hashType
388388
"""
389389

390390
@staticmethod
@@ -541,7 +541,7 @@ class ExternalReferenceType(str, Enum):
541541
Enum object that defines the permissible 'types' for an External Reference according to the CycloneDX schema.
542542
543543
.. note::
544-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReferenceType
544+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_externalReferenceType
545545
"""
546546
# see `_ExternalReferenceSerializationHelper.__CASES` for view/case map
547547
ADVERSARY_MODEL = 'adversary-model' # Only supported in >= 1.5
@@ -809,7 +809,7 @@ class ExternalReference:
809809
a CycloneDX BOM document.
810810
811811
.. note::
812-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_externalReference
812+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_externalReference
813813
"""
814814

815815
def __init__(

cyclonedx/model/bom.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class BomMetaData:
6161
This is our internal representation of the metadata complex type within the CycloneDX standard.
6262
6363
.. note::
64-
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata
64+
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/xml/#type_metadata
6565
"""
6666

6767
def __init__(
@@ -405,7 +405,7 @@ def metadata(self) -> BomMetaData:
405405
Metadata object instance for this Bom.
406406
407407
.. note::
408-
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/#type_metadata
408+
See the CycloneDX Schema for Bom metadata: https://cyclonedx.org/docs/1.6/xml/#type_metadata
409409
"""
410410
return self._metadata
411411

cyclonedx/model/component.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ class ComponentScope(str, Enum):
197197
Enum object that defines the permissable 'scopes' for a Component according to the CycloneDX schema.
198198
199199
.. note::
200-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_scope
200+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_scope
201201
"""
202202
# see `_ComponentScopeSerializationHelper.__CASES` for view/case map
203203
REQUIRED = 'required'
@@ -253,7 +253,7 @@ class ComponentType(str, Enum):
253253
Enum object that defines the permissible 'types' for a Component according to the CycloneDX schema.
254254
255255
.. note::
256-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification
256+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_classification
257257
"""
258258
# see `_ComponentTypeSerializationHelper.__CASES` for view/case map
259259
APPLICATION = 'application'
@@ -937,7 +937,7 @@ class Component(Dependable):
937937
This is our internal representation of a Component within a Bom.
938938
939939
.. note::
940-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_component
940+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_component
941941
"""
942942

943943
@staticmethod

cyclonedx/model/crypto.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
Introduced in CycloneDX v1.6
2323
2424
.. note::
25-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
25+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
2626
"""
2727

2828
from collections.abc import Iterable
@@ -48,7 +48,7 @@ class CryptoAssetType(str, Enum):
4848
Introduced in CycloneDX v1.6
4949
5050
.. note::
51-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
51+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
5252
"""
5353

5454
ALGORITHM = 'algorithm'
@@ -67,7 +67,7 @@ class CryptoPrimitive(str, Enum):
6767
Introduced in CycloneDX v1.6
6868
6969
.. note::
70-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
70+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
7171
"""
7272

7373
AE = 'ae'
@@ -98,7 +98,7 @@ class CryptoExecutionEnvironment(str, Enum):
9898
Introduced in CycloneDX v1.6
9999
100100
.. note::
101-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
101+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
102102
"""
103103

104104
HARDWARE = 'hardware'
@@ -120,7 +120,7 @@ class CryptoImplementationPlatform(str, Enum):
120120
Introduced in CycloneDX v1.6
121121
122122
.. note::
123-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
123+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
124124
"""
125125

126126
ARMV7_A = 'armv7-a'
@@ -150,7 +150,7 @@ class CryptoCertificationLevel(str, Enum):
150150
Introduced in CycloneDX v1.6
151151
152152
.. note::
153-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
153+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
154154
"""
155155

156156
NONE = 'none'
@@ -196,7 +196,7 @@ class CryptoMode(str, Enum):
196196
Introduced in CycloneDX v1.6
197197
198198
.. note::
199-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
199+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
200200
"""
201201

202202
CBC = 'cbc'
@@ -221,7 +221,7 @@ class CryptoPadding(str, Enum):
221221
Introduced in CycloneDX v1.6
222222
223223
.. note::
224-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
224+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
225225
"""
226226

227227
PKCS5 = 'pkcs5'
@@ -244,7 +244,7 @@ class CryptoFunction(str, Enum):
244244
Introduced in CycloneDX v1.6
245245
246246
.. note::
247-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
247+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
248248
"""
249249

250250
DECAPSULATE = 'decapsulate'
@@ -273,7 +273,7 @@ class AlgorithmProperties:
273273
Introduced in CycloneDX v1.6
274274
275275
.. note::
276-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
276+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
277277
"""
278278

279279
def __init__(
@@ -525,7 +525,7 @@ class CertificateProperties:
525525
526526
527527
.. note::
528-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
528+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
529529
"""
530530

531531
def __init__(
@@ -700,7 +700,7 @@ class RelatedCryptoMaterialType(str, Enum):
700700
Introduced in CycloneDX v1.6
701701
702702
.. note::
703-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
703+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
704704
"""
705705

706706
ADDITIONAL_DATA = 'additional-data'
@@ -735,7 +735,7 @@ class RelatedCryptoMaterialState(str, Enum):
735735
Introduced in CycloneDX v1.6
736736
737737
.. note::
738-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
738+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
739739
"""
740740

741741
ACTIVE = 'active'
@@ -757,7 +757,7 @@ class RelatedCryptoMaterialSecuredBy:
757757
758758
759759
.. note::
760-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
760+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
761761
"""
762762

763763
def __init__(
@@ -828,7 +828,7 @@ class RelatedCryptoMaterialProperties:
828828
829829
830830
.. note::
831-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
831+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
832832
"""
833833

834834
def __init__(
@@ -1072,7 +1072,7 @@ class ProtocolPropertiesType(str, Enum):
10721072
Introduced in CycloneDX v1.6
10731073
10741074
.. note::
1075-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
1075+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
10761076
"""
10771077

10781078
IKE = 'ike'
@@ -1097,7 +1097,7 @@ class ProtocolPropertiesCipherSuite:
10971097
10981098
10991099
.. note::
1100-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
1100+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
11011101
"""
11021102

11031103
def __init__(
@@ -1190,7 +1190,7 @@ class Ikev2TransformTypes:
11901190
11911191
11921192
.. note::
1193-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
1193+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
11941194
"""
11951195

11961196
def __init__(
@@ -1332,7 +1332,7 @@ class ProtocolProperties:
13321332
13331333
13341334
.. note::
1335-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
1335+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
13361336
"""
13371337

13381338
def __init__(
@@ -1457,7 +1457,7 @@ class CryptoProperties:
14571457
14581458
14591459
.. note::
1460-
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/#type_cryptoPropertiesType
1460+
See the CycloneDX Schema for hashType: https://cyclonedx.org/docs/1.6/xml/#type_cryptoPropertiesType
14611461
"""
14621462

14631463
def __init__(

cyclonedx/model/impact_analysis.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class ImpactAnalysisAffectedStatus(str, Enum):
4545
has not disclosed the status.
4646
4747
.. note::
48-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisAffectedStatusType
48+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisAffectedStatusType
4949
"""
5050

5151
AFFECTED = 'affected'
@@ -59,7 +59,7 @@ class ImpactAnalysisJustification(str, Enum):
5959
Enum object that defines the rationale of why the impact analysis state was asserted.
6060
6161
.. note::
62-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisJustificationType
62+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisJustificationType
6363
"""
6464

6565
CODE_NOT_PRESENT = 'code_not_present'
@@ -79,7 +79,7 @@ class ImpactAnalysisResponse(str, Enum):
7979
Enum object that defines the valid rationales as to why the impact analysis state was asserted.
8080
8181
.. note::
82-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisResponsesType
82+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisResponsesType
8383
"""
8484

8585
CAN_NOT_FIX = 'can_not_fix'
@@ -95,7 +95,7 @@ class ImpactAnalysisState(str, Enum):
9595
Enum object that defines the permissible impact analysis states.
9696
9797
.. note::
98-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_impactAnalysisStateType
98+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_impactAnalysisStateType
9999
"""
100100

101101
RESOLVED = 'resolved'

cyclonedx/model/license.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ class LicenseAcknowledgement(str, Enum):
4747
4848
.. note::
4949
See the CycloneDX Schema for hashType:
50-
https://cyclonedx.org/docs/1.6/#type_licenseAcknowledgementEnumerationType
50+
https://cyclonedx.org/docs/1.6/xml/#type_licenseAcknowledgementEnumerationType
5151
"""
5252

5353
CONCLUDED = 'concluded'

cyclonedx/model/lifecycle.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
Introduced in CycloneDX v1.5
2323
2424
.. note::
25-
See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/#metadata_lifecycles
25+
See the CycloneDX Schema for lifecycles: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
2626
"""
2727

2828
from enum import Enum
@@ -47,7 +47,7 @@ class LifecyclePhase(str, Enum):
4747
Enum object that defines the permissible 'phase' for a Lifecycle according to the CycloneDX schema.
4848
4949
.. note::
50-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_classification
50+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_classification
5151
"""
5252
DESIGN = 'design'
5353
PRE_BUILD = 'pre-build'
@@ -64,7 +64,7 @@ class PredefinedLifecycle:
6464
Object that defines pre-defined phases in the product lifecycle.
6565
6666
.. note::
67-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#metadata_lifecycles
67+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
6868
"""
6969

7070
def __init__(self, phase: LifecyclePhase) -> None:
@@ -103,7 +103,7 @@ class NamedLifecycle:
103103
Object that defines custom state in the product lifecycle.
104104
105105
.. note::
106-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#metadata_lifecycles
106+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#metadata_lifecycles
107107
"""
108108

109109
def __init__(self, name: str, *, description: Optional[str] = None) -> None:

cyclonedx/model/release_note.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class ReleaseNotes:
3333
This is our internal representation of a `releaseNotesType` for a Component in a BOM.
3434
3535
.. note::
36-
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/#type_releaseNotesType
36+
See the CycloneDX Schema definition: https://cyclonedx.org/docs/1.6/xml/#type_releaseNotesType
3737
"""
3838

3939
def __init__(

cyclonedx/model/tool.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class Tool:
4848
In fact, this library will try to provide a compatibility layer if needed.
4949
5050
.. note::
51-
See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.6/#type_toolType
51+
See the CycloneDX Schema for toolType: https://cyclonedx.org/docs/1.6/xml/#type_toolType
5252
"""
5353

5454
def __init__(

0 commit comments

Comments
 (0)