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.

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

Conversation

heckj
Copy link
Member

@heckj heckj commented Jun 16, 2025

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:

  • LinkableEntities.json
  • RenderNode.spec.json

Dependencies

none

Testing

Manually verified the output doesn't present warnings when code generation is run with OpenAPI generator:

An example command:

git clone https://github.com/apple/swift-openapi-generator
cd swift-openapi-generator
swift run swift-openapi-generator generate --mode types --output-directory ~/foo /Users/joeheck/src/swift-docc/Sources/SwiftDocC/SwiftDocC.docc/Resources/LinkableEntities.json

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

@heckj heckj requested a review from franklinsch June 16, 2025 15:46
@heckj heckj self-assigned this Jun 16, 2025
@heckj
Copy link
Member Author

heckj commented Jun 16, 2025

@swift-ci please test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

required key in LinkableEntities schema not matched in property map
1 participant