Skip to content

Commit 3225155

Browse files
committed
fixes declaration for Metadata to match the actual content produced
1 parent b2975d8 commit 3225155

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

Sources/SwiftDocC/SwiftDocC.docc/Resources/Metadata.json

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,17 @@
1010
"schemas": {
1111
"Metadata": {
1212
"type": "object",
13+
"description": "maps to Maps to https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Model/BuildMetadata.swift#L14",
1314
"required": [
1415
"bundleDisplayName",
15-
"bundleIdentifier",
16+
"bundleID",
1617
"schemaVersion"
1718
],
1819
"properties": {
1920
"bundleDisplayName": {
2021
"type": "string"
2122
},
22-
"bundleIdentifier": {
23+
"bundleID": {
2324
"type": "string"
2425
},
2526
"schemaVersion": {
@@ -28,6 +29,7 @@
2829
}
2930
},
3031
"SchemaVersion": {
32+
"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",
3133
"type": "object",
3234
"required": [
3335
"major",
@@ -43,6 +45,14 @@
4345
},
4446
"patch": {
4547
"type": "integer"
48+
},
49+
"prerelease": {
50+
"type": "string",
51+
"description": "The optional prerelease version component, which may contain non-numeric characters."
52+
},
53+
"buildMetadata": {
54+
"type": "string",
55+
"description": "Optional additional build metadata."
4656
}
4757
}
4858
}

Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@
99
"components": {
1010
"schemas": {
1111
"RenderIndex": {
12+
"description": "maps to https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Indexing/RenderIndexJSON/RenderIndex.swift#L24.",
1213
"type": "object",
1314
"required": [
1415
"schemaVersion",
15-
"interfaceLanguages"
16+
"interfaceLanguages",
1617
],
1718
"properties": {
1819
"schemaVersion": {
@@ -42,6 +43,7 @@
4243
}
4344
},
4445
"Node": {
46+
"description": "maps to https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Indexing/RenderIndexJSON/RenderIndex.swift#L117.",
4547
"type": "object",
4648
"required": [
4749
"title"

0 commit comments

Comments
 (0)