The Open API definition is not valid

[deniurchak]

I am trying to generated a Go client from the Open API v3 spec. I am using this tool https://github.com/deepmap/oapi-codegen .
I copied the Open Api spec to a local file named openapi.yaml. The open api spec validator showed several errors:

• use of properties in ListPushCredentialsResponse
• use of summary in AutorespConfigsResponseSchema
• descending in CreateTeXMLSecretRequest
• required in EnqueueRequest
  etc.

I fixed these errors manually and ran this command oapi-codegen -include-tags Documents,'Porting Order','Phone Number Orders' -generate types,client,spec -package generated_telnyx ./telnyx/openapi.yaml > ./telnyx/generated/telnyx.gen.go gives the following error:

error loading swagger spec in ./telnyx/openapi.yaml
: bad data in "#/components/parameters/ConnectionId" (expecting ref to schema object)make: *** [generate-oapi-telnyx] Error 1

I think the errors are related to the use of refs in several places. Would be great if you could take a look at it and see if it is possible to generate a client from an existing spec.

[TylerBrinks]

I have the same issue; the current v3 spec is invalid in several areas.

Tested using:

• NSwag
• Open API (openapi-generator-cli)
• Kiota
• Refitter

None of these Open API tools successfully generate buildable output; some cannot parse the file at all.

Open API CLI reports the following:

        -attribute components.schemas.AdvancedOrderRequest.default is not of type `array`
        -components.parameters.Parameter name StartTime> doesn't adhere to regular expression ^[a-zA-Z0-9\.\-_]+$
        -attribute paths.'/reports/wdrs'(get).parameters.[sort].schemas.default is not of type `array`
        -attribute paths.'/texml/calls/{application_id}'(post).operationId is repeated
        -attribute paths.'/porting_orders/{id}/comments'(post).operationId is repeated
        -attribute paths.'/portouts/reports/{id}'(get).operationId is repeated
        -attribute paths.'/texml/calls/{call_sid}/update'(post).operationId is repeated
        -components.parameters.Parameter name EndTime> doesn't adhere to regular expression ^[a-zA-Z0-9\.\-_]+$
        -attribute components.schemas.AuditEventChanges.items is missing
        -components.parameters.Parameter name EndTime< doesn't adhere to regular expression ^[a-zA-Z0-9\.\-_]+$
        -components.parameters.Parameter name StartTime< doesn't adhere to regular expression ^[a-zA-Z0-9\.\-_]+$
        -attribute paths.'/usage_reports'(get).operationId is repeated

• Parameters with names like StartTime> or EndTime< are not supported by most clients
• "Authorization: Bearer <TOKEN>" as a name in Usage Report and AuthorizationBearer objects causes most client tools issues creating language-specific variable names; it should follow JSON naming standards.

The Spec3.json file requires substantial modification to make client generators work. openapi-generator-cli should be the de facto on the schema.

Validating the schema

Running openapi-generator-cli without the "--skip-validate-spec" flag will reproduce the errors above:

From the CLI:

openapi-generator-cli generate -g csharp -i spec3.json

https://openapi-generator.tech/docs/