OpenAPI v3 validation fails over identifier regex

[heyvister]

Hi,

I'm trying to convert existing customer's v2 to v3. The conversion has succeeded but when I validate it afterwards it fails over invalid regex:
"identifier "DeltaMapper[Infant]" is not supported by OpenAPIv3 standard (regexp: "^[a-zA-Z0-9.-]+$")_"

Is there an option to expose const identifierPattern = ^[a-zA-Z0-9._-]+$ @ components.go ?

Tnx

[fenollp]

Indeed ValidateIdentifier doesn't seem to be backed by any explicit wording in https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md
Git blame returns a 4 years old commit with no description by the original author of this lib.

I'd say we can safely remove this whole function. I'd rather we have per-case validation instead:

• header names can't contain whitespace nor colons
• query parameters probably shouldn't contain =?&[]# chars (but then again, maybe they can if they get urlencoded?)
• path parameters must not contain slashes (ditto wrt encoding)

A PR replacing ValidateIdentifier usage with these constraints (thus relaxing the current constraints) would be great.

[fenollp]

Alright I got my identifiers mixed up: this is about the names of components. It turns out the spec does mention this

All the fixed fields declared above are objects that MUST use keys that match the regular expression: ^[a-zA-Z0-9.-_]+$.

If handling not quite OpenAPI spec is alright with you we can work out a way for you to override this. Do you need this tweakable

• at the package variable level, or
• per specification?

The first one is the quickest to get working, in which case I'd suggest exporting a ComponentsIdentifiersRegexp that one can override through regexp.MustCompile.

[heyvister]

Hi Pierre,

Thanks for the clarification regarding OpenAPI specification for components keys regular expression.
Indeed I would rather it to be tweakable, I would go with the quickest option of exporting ComponentsIdentifiersRegexp at package variable level.