Skip to content

fixes declaration for Metadata to match the actual content produced #1364

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
heckj wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fixes declaration for Metadata to match the actual content produced #1364

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3225155
fixes declaration for Metadata to match the actual content produced
heckj Nov 26, 2025
06b9ff9
fixing extraneous comma
heckj Dec 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions Sources/SwiftDocC/SwiftDocC.docc/Resources/Metadata.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Copy link
Contributor

@d-ronnqvist d-ronnqvist Nov 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the model used to spell out "identifier" then I think that it could be worth updating the model so that it does that again.

Copy link
Member Author

@heckj heckj Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't looked at what DocC Render expects there and if that would have negative downstream impacts. I was basing this on https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Indexing/RenderIndexJSON/RenderIndex.swift#L24 and the content that was explicitly in a generated DocC archive to support decoding it.

"schemaVersion"
],
"properties": {
"bundleDisplayName": {
"type": "string"
},
"bundleIdentifier": {
"bundleID": {
"type": "string"
},
"schemaVersion": {
Expand All @@ -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",
Expand All @@ -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."
}
}
}
Expand Down
2 changes: 2 additions & 0 deletions Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"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",
Expand Down Expand Up @@ -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"
Expand Down