fixes declaration for Metadata to match the actual content produced #1364
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d-ronnqvist
reviewed
Nov 27, 2025
Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json
Outdated
Show resolved
Hide resolved
| "required": [ | ||
| "bundleDisplayName", | ||
| "bundleIdentifier", | ||
| "bundleID", |
Contributor
There was a problem hiding this comment.
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.
Member
Author
There was a problem hiding this comment.
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.
Member
Author
|
I have no idea why I closed this... |
Member
Author
|
@swift-ci please test |
heckj
force-pushed
the
decodingArchiveFix
branch
from
8e98f29 to
3225155
Compare
Member
Author
|
@swift-ci please test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes to the declarations for the JSON data structures as encoded in the DocC Archive