Skip to content

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.

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

resolves mismatched in OpenAPI resource specs for type generation #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -543,7 +543,7 @@
"type": "object",
"required": [
"type",
"identifier"
"reference"
Copy link
Contributor

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

],
"properties": {
"type": {
Expand Down
11 changes: 4 additions & 7 deletions Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,7 @@
"type": "object",
"required": [
"kind",
"tiles",
"content"
"tiles"
],
"properties": {
"kind": {
Expand Down Expand Up @@ -526,8 +525,7 @@
"kind",
"content",
"media",
"mediaPosition",
"layout"
"mediaPosition"
],
"properties": {
"kind": {
Expand Down Expand Up @@ -1795,7 +1793,7 @@
"type": "object",
"required": [
"type",
"identifier"
"reference"
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here

],
"properties": {
"type": {
Expand Down Expand Up @@ -1956,7 +1954,7 @@
"type": "object",
"required": [
"reference",
"kind"
"sections"
Copy link
Contributor

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"

],
"properties": {
"reference": {
Expand Down Expand Up @@ -2499,7 +2497,6 @@
},
"MentionsRenderSection": {
"required": [
"kind",
"mentions"
],
"type": "object",
Expand Down