fixes declaration for Metadata to match the actual content produced#1364
fixes declaration for Metadata to match the actual content produced#1364heckj wants to merge 4 commits into
Conversation
| "required": [ | ||
| "bundleDisplayName", | ||
| "bundleIdentifier", | ||
| "bundleID", |
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.
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.
There was a problem hiding this comment.
I can see that it was renamed here from bundleIdentifier to bundleID here. If we were to rename it to bundleIdentifier, we'd likely want a custom Decodable implementation for backwards compatibility
There was a problem hiding this comment.
I'm really fine with either - renaming it back or updating the spec - I'm just trying to make sure the spec that we're publishing stays aligned with what the JSON output actually is from DocC today.
@franklinsch Where would we want/need a custom Decodable implementation for backwards compatibility if that's the preferred path.
|
I have no idea why I closed this... |
|
@swift-ci please test |
heckj
force-pushed
the
decodingArchiveFix
branch
from
8e98f29 to
3225155
Compare
|
@swift-ci please test |
| "required": [ | ||
| "bundleDisplayName", | ||
| "bundleIdentifier", | ||
| "bundleID", |
There was a problem hiding this comment.
I can see that it was renamed here from bundleIdentifier to bundleID here. If we were to rename it to bundleIdentifier, we'd likely want a custom Decodable implementation for backwards compatibility
Co-authored-by: Franklin Schrans <fschrans@apple.com>
|
@swift-ci please test |
3 participants
Fixes to the declarations for the JSON data structures as encoded in the DocC Archive