From 32251558ff61775c9794722ccde9118a8c5168a9 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Wed, 26 Nov 2025 10:56:36 -0800 Subject: [PATCH 1/2] fixes declaration for Metadata to match the actual content produced --- .../SwiftDocC.docc/Resources/Metadata.json | 14 ++++++++++++-- .../SwiftDocC.docc/Resources/RenderIndex.spec.json | 4 +++- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/Metadata.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/Metadata.json index 043a45977a..026bf57166 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/Metadata.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/Metadata.json @@ -10,16 +10,17 @@ "schemas": { "Metadata": { "type": "object", + "description": "maps to Maps to https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Model/BuildMetadata.swift#L14", "required": [ "bundleDisplayName", - "bundleIdentifier", + "bundleID", "schemaVersion" ], "properties": { "bundleDisplayName": { "type": "string" }, - "bundleIdentifier": { + "bundleID": { "type": "string" }, "schemaVersion": { @@ -28,6 +29,7 @@ } }, "SchemaVersion": { + "description": "A version that follows the [Semantic Versioning](https://semver.org) specification. Maps to https: https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Model/Rendering/SemanticVersion.swift#L14", "type": "object", "required": [ "major", @@ -43,6 +45,14 @@ }, "patch": { "type": "integer" + }, + "prerelease": { + "type": "string", + "description": "The optional prerelease version component, which may contain non-numeric characters." + }, + "buildMetadata": { + "type": "string", + "description": "Optional additional build metadata." } } } diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json index d100305d97..3303bb742e 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json @@ -9,10 +9,11 @@ "components": { "schemas": { "RenderIndex": { + "description": "maps to https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Indexing/RenderIndexJSON/RenderIndex.swift#L24.", "type": "object", "required": [ "schemaVersion", - "interfaceLanguages" + "interfaceLanguages", ], "properties": { "schemaVersion": { @@ -42,6 +43,7 @@ } }, "Node": { + "description": "maps to https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Indexing/RenderIndexJSON/RenderIndex.swift#L117.", "type": "object", "required": [ "title" From 06b9ff90119c97b3381e77b751bcfdb5e3a399f5 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Mon, 1 Dec 2025 10:25:04 -0800 Subject: [PATCH 2/2] fixing extraneous comma --- .../SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json index 3303bb742e..e79750a5fc 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json @@ -13,7 +13,7 @@ "type": "object", "required": [ "schemaVersion", - "interfaceLanguages", + "interfaceLanguages" ], "properties": { "schemaVersion": {