From 8d94c0b0d6de25b6d93ea2f4c10f1f5dad905ae2 Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Mon, 16 Jun 2025 08:33:33 -0700 Subject: [PATCH 1/2] fixes OpenAPI spec mismatches between require properties and available properties --- .../SwiftDocC.docc/Resources/LinkableEntities.json | 2 +- .../SwiftDocC.docc/Resources/RenderNode.spec.json | 11 ++++------- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json index 6f156a7423..e70638b04c 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json @@ -543,7 +543,7 @@ "type": "object", "required": [ "type", - "identifier" + "reference" ], "properties": { "type": { diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json index 4ced315007..1044a735db 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json @@ -360,8 +360,7 @@ "type": "object", "required": [ "kind", - "tiles", - "content" + "tiles" ], "properties": { "kind": { @@ -526,8 +525,7 @@ "kind", "content", "media", - "mediaPosition", - "layout" + "mediaPosition" ], "properties": { "kind": { @@ -1795,7 +1793,7 @@ "type": "object", "required": [ "type", - "identifier" + "reference" ], "properties": { "type": { @@ -1956,7 +1954,7 @@ "type": "object", "required": [ "reference", - "kind" + "sections" ], "properties": { "reference": { @@ -2499,7 +2497,6 @@ }, "MentionsRenderSection": { "required": [ - "kind", "mentions" ], "type": "object", From 498ce90b76659034d3b064103cc411087103d67f Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Wed, 20 Aug 2025 15:45:18 -0700 Subject: [PATCH 2/2] updating specs with feedback --- .../SwiftDocC.docc/Resources/LinkableEntities.json | 4 ++-- .../SwiftDocC.docc/Resources/RenderNode.spec.json | 8 ++++---- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json index e70638b04c..8b79d1c7f7 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json @@ -543,14 +543,14 @@ "type": "object", "required": [ "type", - "reference" + "identifier" ], "properties": { "type": { "type": "string", "enum": ["icon", "card"] }, - "reference": { + "identifier": { "type": "string", "format": "reference(ImageRenderReference)" } diff --git a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json index 1044a735db..f779920364 100644 --- a/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json +++ b/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderNode.spec.json @@ -1793,14 +1793,14 @@ "type": "object", "required": [ "type", - "reference" + "identifier" ], "properties": { "type": { "type": "string", "enum": ["icon", "card"] }, - "reference": { + "identifier": { "type": "string", "format": "reference(ImageRenderReference)" } @@ -1954,14 +1954,14 @@ "type": "object", "required": [ "reference", - "sections" + "kind" ], "properties": { "reference": { "type": "string", "format": "reference(RenderReference)" }, - "sections": { + "kind": { "type": "string", "enum": ["task", "assessment", "heading"] }