-
Notifications
You must be signed in to change notification settings - Fork 146
resolves mismatched in OpenAPI resource specs for type generation #1239
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.
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
base: main
Are you sure you want to change the base?
Conversation
@swift-ci please test |
1 similar comment
@swift-ci please test |
@@ -543,7 +543,7 @@ | |||
"type": "object", | |||
"required": [ | |||
"type", | |||
"identifier" | |||
"reference" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless I'm looking at the wrong place, it seems like identifier
is correct for this one: https://github.com/swiftlang/swift-docc/blob/main/Sources/SwiftDocC/Model/Rendering/References/TopicImage.swift#L21
@@ -1795,7 +1793,7 @@ | |||
"type": "object", | |||
"required": [ | |||
"type", | |||
"identifier" | |||
"reference" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here
@@ -1956,7 +1954,7 @@ | |||
"type": "object", | |||
"required": [ | |||
"reference", | |||
"kind" | |||
"sections" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was a bit difficult to track down, but I believe HierarchySection
is RenderHierarchyLandmark
, meaning that kind
is required and there is no sections
array. The enumeration listed in properties below should be "kind"
fixes OpenAPI spec mismatches between require properties and available properties
resolves #1222
Summary
Updates the OpenAPI spec files for the outputs used in DocC archive to resolve warnings in mismatches between required fields and available properties defined in those fields
Updates:
Dependencies
none
Testing
Manually verified the output doesn't present warnings when code generation is run with OpenAPI generator:
An example command:
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded