RenderIndex.spec.json has required property that isn't defined in OpenAPI spec

[heckj]

Description

The RenderIndex OpenAPI spec has a required field for RenderIndex that isn't defined in the schema: schemaVersion

"RenderIndex": {
                "type": "object",
                "required": [
                    "schemaVersion",
                    "interfaceLanguages"
                ],
                "properties": {
                    "identifier": {
                        "$ref": "#/components/schemas/SchemaVersion"
                    },
                    "interfaceLanguages": {
                        "type": "object",
                        "additionalProperties": {
                            "type": "array",
                            "items": {
                                "$ref": "#/components/schemas/Node"
                            }
                        }
                    },
...

Checklist

• If possible, I've reproduced the issue using the main branch of this package.
• This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

No response

Actual behavior

No response

Steps To Reproduce

git clone https://github.com/apple/swift-openapi-generator
cd swift-openapi-generator
swift run swift-openapi-generator generate --mode types --output-directory . ~/src/swift-project/swift-docc/Sources/SwiftDocC/SwiftDocC.docc/Resources/RenderIndex.spec.json --dry-run

Warning generated:

warning: A property name only appears in the required list, but not in the properties map - this is likely a typo; skipping this property. [context: foundIn=Components.Schemas.RenderIndex (#/components/schemas/RenderIndex)/schemaVersion]

Swift-DocC Version Information

f47942a

Swift Compiler Version Information

Apple Swift version 6.1 (swift-6.1-RELEASE)
Target: arm64-apple-macosx15.0

[heckj]

Should identifier be in the required fields instead of schemaVersion, since it has that type?

[heckj]

I didn't spot anything that provide verification that the schema provided actually matches renderer output - or that it was able to be validated by OpenAPI. While I believe I have the correct answer in the fix, what's the best way to provide tests for this?

The path that immediately comes to mind would be to render a sample docc catalog of some form (I used SlothCreator in my exploration of the issue), and then use generated code from the provided OpenAPI spec to read and validate the schema based on the provided content in /Sources/SwiftDocC/SwiftDocC.docc/Resources/*

I'd be tempted to lean into use swift-openapi-generator as a dependency in such a test - would that be acceptable? Or is there another path at testing that would be preferred?