Use the actual list of model entries #978

zvr · 2024-07-02T15:09:46Z

The current publishing setup uses a static list of pages in

Lines 22 to 327 in aac3e38

    
           - model: 
        
             - Core: 
        
               - 'Description': model/Core/Core.md 
        
               - Classes: 
        
                 - model/Core/Classes/Agent.md 
        
                 - model/Core/Classes/Annotation.md 
        
                 - model/Core/Classes/Artifact.md 
        
                 - model/Core/Classes/Bom.md 
        
                 - model/Core/Classes/Bundle.md 
        
                 - model/Core/Classes/CreationInfo.md 
        
                 - model/Core/Classes/DictionaryEntry.md 
        
                 - model/Core/Classes/Element.md 
        
                 - model/Core/Classes/ElementCollection.md 
        
                 - model/Core/Classes/ExternalIdentifier.md 
        
                 - model/Core/Classes/ExternalMap.md 
        
                 - model/Core/Classes/ExternalRef.md 
        
                 - model/Core/Classes/Hash.md 
        
                 - model/Core/Classes/IntegrityMethod.md 
        
                 - model/Core/Classes/LifecycleScopedRelationship.md 
        
                 - model/Core/Classes/NamespaceMap.md 
        
                 - model/Core/Classes/Organization.md 
        
                 - model/Core/Classes/PackageVerificationCode.md 
        
                 - model/Core/Classes/Person.md 
        
                 - model/Core/Classes/PositiveIntegerRange.md 
        
                 - model/Core/Classes/Relationship.md 
        
                 - model/Core/Classes/SoftwareAgent.md 
        
                 - model/Core/Classes/SpdxDocument.md 
        
                 - model/Core/Classes/Tool.md 
        
               - Properties: 
        
                 - model/Core/Properties/algorithm.md 
        
                 - model/Core/Properties/annotationType.md 
        
                 - model/Core/Properties/beginIntegerRange.md 
        
                 - model/Core/Properties/builtTime.md 
        
                 - model/Core/Properties/comment.md 
        
                 - model/Core/Properties/completeness.md 
        
                 - model/Core/Properties/contentType.md 
        
                 - model/Core/Properties/context.md 
        
                 - model/Core/Properties/created.md 
        
                 - model/Core/Properties/createdBy.md 
        
                 - model/Core/Properties/createdUsing.md 
        
                 - model/Core/Properties/creationInfo.md 
        
                 - model/Core/Properties/dataLicense.md 
        
                 - model/Core/Properties/definingArtifact.md 
        
                 - model/Core/Properties/description.md 
        
                 - model/Core/Properties/element.md 
        
                 - model/Core/Properties/endIntegerRange.md 
        
                 - model/Core/Properties/endTime.md 
        
                 - model/Core/Properties/extension.md 
        
                 - model/Core/Properties/externalIdentifier.md 
        
                 - model/Core/Properties/externalIdentifierType.md 
        
                 - model/Core/Properties/externalRef.md 
        
                 - model/Core/Properties/externalRefType.md 
        
                 - model/Core/Properties/externalSpdxId.md 
        
                 - model/Core/Properties/from.md 
        
                 - model/Core/Properties/hashValue.md 
        
                 - model/Core/Properties/identifier.md 
        
                 - model/Core/Properties/identifierLocator.md 
        
                 - model/Core/Properties/imports.md 
        
                 - model/Core/Properties/issuingAuthority.md 
        
                 - model/Core/Properties/key.md 
        
                 - model/Core/Properties/locationHint.md 
        
                 - model/Core/Properties/locator.md 
        
                 - model/Core/Properties/name.md 
        
                 - model/Core/Properties/namespace.md 
        
                 - model/Core/Properties/namespaceMap.md 
        
                 - model/Core/Properties/originatedBy.md 
        
                 - model/Core/Properties/packageVerificationCodeExcludedFile.md 
        
                 - model/Core/Properties/prefix.md 
        
                 - model/Core/Properties/profileConformance.md 
        
                 - model/Core/Properties/relationshipType.md 
        
                 - model/Core/Properties/releaseTime.md 
        
                 - model/Core/Properties/rootElement.md 
        
                 - model/Core/Properties/scope.md 
        
                 - model/Core/Properties/spdxId.md 
        
                 - model/Core/Properties/specVersion.md 
        
                 - model/Core/Properties/standardName.md 
        
                 - model/Core/Properties/startTime.md 
        
                 - model/Core/Properties/statement.md 
        
                 - model/Core/Properties/subject.md 
        
                 - model/Core/Properties/summary.md 
        
                 - model/Core/Properties/suppliedBy.md 
        
                 - model/Core/Properties/supportLevel.md 
        
                 - model/Core/Properties/to.md 
        
                 - model/Core/Properties/validUntilTime.md 
        
                 - model/Core/Properties/value.md 
        
                 - model/Core/Properties/verifiedUsing.md 
        
               - Vocabularies: 
        
                 - model/Core/Vocabularies/AnnotationType.md 
        
                 - model/Core/Vocabularies/ExternalIdentifierType.md 
        
                 - model/Core/Vocabularies/ExternalRefType.md 
        
                 - model/Core/Vocabularies/HashAlgorithm.md 
        
                 - model/Core/Vocabularies/LifecycleScopeType.md 
        
                 - model/Core/Vocabularies/PresenceType.md 
        
                 - model/Core/Vocabularies/ProfileIdentifierType.md 
        
                 - model/Core/Vocabularies/RelationshipCompleteness.md 
        
                 - model/Core/Vocabularies/RelationshipType.md 
        
                 - model/Core/Vocabularies/SupportType.md 
        
               - Datatypes: 
        
                 - model/Core/Datatypes/DateTime.md 
        
                 - model/Core/Datatypes/MediaType.md 
        
                 - model/Core/Datatypes/SemVer.md 
        
               - Individuals: 
        
                 - model/Core/Individuals/NoAssertionElement.md 
        
                 - model/Core/Individuals/NoneElement.md 
        
             - Software: 
        
               - 'Description': model/Software/Software.md 
        
               - Classes: 
        
                 - model/Software/Classes/ContentIdentifier.md 
        
                 - model/Software/Classes/File.md 
        
                 - model/Software/Classes/Package.md 
        
                 - model/Software/Classes/Sbom.md 
        
                 - model/Software/Classes/Snippet.md 
        
                 - model/Software/Classes/SoftwareArtifact.md 
        
               - Properties: 
        
                 - model/Software/Properties/additionalPurpose.md 
        
                 - model/Software/Properties/attributionText.md 
        
                 - model/Software/Properties/byteRange.md 
        
                 - model/Software/Properties/contentIdentifier.md 
        
                 - model/Software/Properties/contentIdentifierType.md 
        
                 - model/Software/Properties/contentIdentifierValue.md 
        
                 - model/Software/Properties/contentType.md 
        
                 - model/Software/Properties/copyrightText.md 
        
                 - model/Software/Properties/downloadLocation.md 
        
                 - model/Software/Properties/fileKind.md 
        
                 - model/Software/Properties/homePage.md 
        
                 - model/Software/Properties/lineRange.md 
        
                 - model/Software/Properties/packageUrl.md 
        
                 - model/Software/Properties/packageVersion.md 
        
                 - model/Software/Properties/primaryPurpose.md 
        
                 - model/Software/Properties/sbomType.md 
        
                 - model/Software/Properties/snippetFromFile.md 
        
                 - model/Software/Properties/sourceInfo.md 
        
               - Vocabularies: 
        
                 - model/Software/Vocabularies/ContentIdentifierType.md 
        
                 - model/Software/Vocabularies/FileKindType.md 
        
                 - model/Software/Vocabularies/SbomType.md 
        
                 - model/Software/Vocabularies/SoftwarePurpose.md 
        
             - Security: 
        
               - 'Description': model/Security/Security.md 
        
               - Classes: 
        
                 - model/Security/Classes/CvssV2VulnAssessmentRelationship.md 
        
                 - model/Security/Classes/CvssV3VulnAssessmentRelationship.md 
        
                 - model/Security/Classes/CvssV4VulnAssessmentRelationship.md 
        
                 - model/Security/Classes/EpssVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/ExploitCatalogVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/SsvcVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/VexAffectedVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/VexFixedVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/VexNotAffectedVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/VexUnderInvestigationVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/VexVulnAssessmentRelationship.md 
        
                 - model/Security/Classes/VulnAssessmentRelationship.md 
        
                 - model/Security/Classes/Vulnerability.md 
        
               - Properties: 
        
                 - model/Security/Properties/actionStatement.md 
        
                 - model/Security/Properties/actionStatementTime.md 
        
                 - model/Security/Properties/assessedElement.md 
        
                 - model/Security/Properties/catalogType.md 
        
                 - model/Security/Properties/decisionType.md 
        
                 - model/Security/Properties/exploited.md 
        
                 - model/Security/Properties/impactStatement.md 
        
                 - model/Security/Properties/impactStatementTime.md 
        
                 - model/Security/Properties/justificationType.md 
        
                 - model/Security/Properties/locator.md 
        
                 - model/Security/Properties/modifiedTime.md 
        
                 - model/Security/Properties/percentile.md 
        
                 - model/Security/Properties/probability.md 
        
                 - model/Security/Properties/publishedTime.md 
        
                 - model/Security/Properties/score.md 
        
                 - model/Security/Properties/severity.md 
        
                 - model/Security/Properties/statusNotes.md 
        
                 - model/Security/Properties/vectorString.md 
        
                 - model/Security/Properties/vexVersion.md 
        
                 - model/Security/Properties/withdrawnTime.md 
        
               - Vocabularies: 
        
                 - model/Security/Vocabularies/CvssSeverityType.md 
        
                 - model/Security/Vocabularies/ExploitCatalogType.md 
        
                 - model/Security/Vocabularies/SsvcDecisionType.md 
        
                 - model/Security/Vocabularies/VexJustificationType.md 
        
             - Licensing: 
        
               - 'Description': model/Licensing/Licensing.md 
        
             - SimpleLicensing: 
        
               - 'Description': model/SimpleLicensing/SimpleLicensing.md 
        
               - Classes: 
        
                 - model/SimpleLicensing/Classes/AnyLicenseInfo.md 
        
                 - model/SimpleLicensing/Classes/LicenseExpression.md 
        
                 - model/SimpleLicensing/Classes/SimpleLicensingText.md 
        
               - Properties: 
        
                 - model/SimpleLicensing/Properties/customIdToUri.md 
        
                 - model/SimpleLicensing/Properties/licenseExpression.md 
        
                 - model/SimpleLicensing/Properties/licenseListVersion.md 
        
                 - model/SimpleLicensing/Properties/licenseText.md 
        
             - ExpandedLicensing: 
        
               - 'Description': model/ExpandedLicensing/ExpandedLicensing.md 
        
               - Classes: 
        
                 - model/ExpandedLicensing/Classes/ConjunctiveLicenseSet.md 
        
                 - model/ExpandedLicensing/Classes/CustomLicense.md 
        
                 - model/ExpandedLicensing/Classes/CustomLicenseAddition.md 
        
                 - model/ExpandedLicensing/Classes/DisjunctiveLicenseSet.md 
        
                 - model/ExpandedLicensing/Classes/ExtendableLicense.md 
        
                 - model/ExpandedLicensing/Classes/IndividualLicensingInfo.md 
        
                 - model/ExpandedLicensing/Classes/License.md 
        
                 - model/ExpandedLicensing/Classes/LicenseAddition.md 
        
                 - model/ExpandedLicensing/Classes/ListedLicense.md 
        
                 - model/ExpandedLicensing/Classes/ListedLicenseException.md 
        
                 - model/ExpandedLicensing/Classes/OrLaterOperator.md 
        
                 - model/ExpandedLicensing/Classes/WithAdditionOperator.md 
        
               - Properties: 
        
                 - model/ExpandedLicensing/Properties/additionText.md 
        
                 - model/ExpandedLicensing/Properties/deprecatedVersion.md 
        
                 - model/ExpandedLicensing/Properties/isDeprecatedAdditionId.md 
        
                 - model/ExpandedLicensing/Properties/isDeprecatedLicenseId.md 
        
                 - model/ExpandedLicensing/Properties/isFsfLibre.md 
        
                 - model/ExpandedLicensing/Properties/isOsiApproved.md 
        
                 - model/ExpandedLicensing/Properties/licenseXml.md 
        
                 - model/ExpandedLicensing/Properties/listVersionAdded.md 
        
                 - model/ExpandedLicensing/Properties/member.md 
        
                 - model/ExpandedLicensing/Properties/obsoletedBy.md 
        
                 - model/ExpandedLicensing/Properties/seeAlso.md 
        
                 - model/ExpandedLicensing/Properties/standardAdditionTemplate.md 
        
                 - model/ExpandedLicensing/Properties/standardLicenseHeader.md 
        
                 - model/ExpandedLicensing/Properties/standardLicenseTemplate.md 
        
                 - model/ExpandedLicensing/Properties/subjectAddition.md 
        
                 - model/ExpandedLicensing/Properties/subjectExtendableLicense.md 
        
                 - model/ExpandedLicensing/Properties/subjectLicense.md 
        
               - Individuals: 
        
                 - model/ExpandedLicensing/Individuals/NoAssertionLicense.md 
        
                 - model/ExpandedLicensing/Individuals/NoneLicense.md 
        
             - Dataset: 
        
               - 'Description': model/Dataset/Dataset.md 
        
               - Classes: 
        
                 - model/Dataset/Classes/DatasetPackage.md 
        
               - Properties: 
        
                 - model/Dataset/Properties/anonymizationMethodUsed.md 
        
                 - model/Dataset/Properties/confidentialityLevel.md 
        
                 - model/Dataset/Properties/dataCollectionProcess.md 
        
                 - model/Dataset/Properties/dataPreprocessing.md 
        
                 - model/Dataset/Properties/datasetAvailability.md 
        
                 - model/Dataset/Properties/datasetNoise.md 
        
                 - model/Dataset/Properties/datasetSize.md 
        
                 - model/Dataset/Properties/datasetType.md 
        
                 - model/Dataset/Properties/datasetUpdateMechanism.md 
        
                 - model/Dataset/Properties/hasSensitivePersonalInformation.md 
        
                 - model/Dataset/Properties/intendedUse.md 
        
                 - model/Dataset/Properties/knownBias.md 
        
                 - model/Dataset/Properties/sensor.md 
        
               - Vocabularies: 
        
                 - model/Dataset/Vocabularies/ConfidentialityLevelType.md 
        
                 - model/Dataset/Vocabularies/DatasetAvailabilityType.md 
        
                 - model/Dataset/Vocabularies/DatasetType.md 
        
             - AI: 
        
               - 'Description': model/AI/AI.md 
        
               - Classes: 
        
                 - model/AI/Classes/AIPackage.md 
        
                 - model/AI/Classes/EnergyConsumption.md 
        
                 - model/AI/Classes/EnergyConsumptionDescription.md 
        
               - Properties: 
        
                 - model/AI/Properties/autonomyType.md 
        
                 - model/AI/Properties/domain.md 
        
                 - model/AI/Properties/energyConsumption.md 
        
                 - model/AI/Properties/energyQuantity.md 
        
                 - model/AI/Properties/energyUnit.md 
        
                 - model/AI/Properties/finetuningEnergyConsumption.md 
        
                 - model/AI/Properties/hyperparameter.md 
        
                 - model/AI/Properties/inferenceEnergyConsumption.md 
        
                 - model/AI/Properties/informationAboutApplication.md 
        
                 - model/AI/Properties/informationAboutTraining.md 
        
                 - model/AI/Properties/limitation.md 
        
                 - model/AI/Properties/metric.md 
        
                 - model/AI/Properties/metricDecisionThreshold.md 
        
                 - model/AI/Properties/modelDataPreprocessing.md 
        
                 - model/AI/Properties/modelExplainability.md 
        
                 - model/AI/Properties/safetyRiskAssessment.md 
        
                 - model/AI/Properties/standardCompliance.md 
        
                 - model/AI/Properties/trainingEnergyConsumption.md 
        
                 - model/AI/Properties/typeOfModel.md 
        
                 - model/AI/Properties/useSensitivePersonalInformation.md 
        
               - Vocabularies: 
        
                 - model/AI/Vocabularies/EnergyUnitType.md 
        
                 - model/AI/Vocabularies/SafetyRiskAssessmentType.md 
        
             - Build: 
        
               - 'Description': model/Build/Build.md 
        
               - Classes: 
        
                 - model/Build/Classes/Build.md 
        
               - Properties: 
        
                 - model/Build/Properties/buildEndTime.md 
        
                 - model/Build/Properties/buildId.md 
        
                 - model/Build/Properties/buildStartTime.md 
        
                 - model/Build/Properties/buildType.md 
        
                 - model/Build/Properties/configSourceDigest.md 
        
                 - model/Build/Properties/configSourceEntrypoint.md 
        
                 - model/Build/Properties/configSourceUri.md 
        
                 - model/Build/Properties/environment.md 
        
                 - model/Build/Properties/parameters.md 
        
             - Lite: 
        
               - 'Description': model/Lite/Lite.md 
        
             - Extension: 
        
               - 'Description': model/Extension/Extension.md 
        
               - Classes: 
        
                 - model/Extension/Classes/CdxPropertiesExtension.md 
        
                 - model/Extension/Classes/CdxPropertyEntry.md 
        
                 - model/Extension/Classes/Extension.md 
        
               - Properties: 
        
                 - model/Extension/Properties/cdxPropName.md 
        
                 - model/Extension/Properties/cdxPropValue.md 
        
                 - model/Extension/Properties/cdxProperty.md

This might not correspond to the actual contents of the model.

The generation of mkdocs input (all the .md files) also generates a list, ready to be included in the file.

The publishing setup should be updated to include and use this, every time the web content is being generated.

bact · 2024-07-30T09:38:46Z

#995 merged, our mkdocs.yml now using the actual list of model entries generated from the spec-parser.

kestewart · 2024-08-11T22:04:07Z

This appears to now be fixed. Closing.

zvr added the publishing label Jul 2, 2024

This was referenced Jul 2, 2024

The software Profile contains the property None #957

Closed

Update publish_v3.yml to alias "v3.0" (and later "v3.0.1") as "latest" #950

Merged

Automate the mkdocs table of contents #916

Closed

bact mentioned this issue Jul 24, 2024

Publish 3.0.1 as v3.0.1-draft #995

Merged

kestewart added this to the 3.0.1 milestone Aug 11, 2024

kestewart closed this as completed Aug 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use the actual list of model entries #978

Use the actual list of model entries #978

zvr commented Jul 2, 2024

bact commented Jul 30, 2024

kestewart commented Aug 11, 2024

Use the actual list of model entries #978

Use the actual list of model entries #978

Comments

zvr commented Jul 2, 2024

bact commented Jul 30, 2024

kestewart commented Aug 11, 2024