OpenAPI Codegen failing for "Given type is not array!"

windymelt · March 20, 2023, 11:55pm

Hi, I’m trying to call OpenAI API via OpenAPI (the service provides openapi yaml file).

When I use tapir codegen plugin, tapir fails:

Missing required field
- Added required: [] for that resource and fixed.
Given type is not array!
- I cannot fix this because it is actually not an array.

Error message follows:

DecodingFailure(Given type is not array!, List(DownField(CreateCompletionRequest), DownField(schemas), DownField(components)))

Corresponding schema is here.

github.com

openai/openai-openapi/blob/8b9c21f34dd76e5d1f2435c6e80b45ca0a6d2be9/openapi.yaml#L2052


      
                type: string
              object:
                type: string
              deleted:
                type: boolean
            required:
              - id
              - object
              - deleted
          
          
CreateCompletionRequest:
            type: object
            properties:
              model: &model_configuration
                description: ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them.
                type: string
              prompt:
                description: &completions_prompt_description |
                  The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.
          
          
        Note that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.

adamw · March 22, 2023, 9:45am

The codegen plugin is in an experimental stage, quite possible some features are missing. We would need a smaller reproducing example to start fixing this.

However, something that I wanted to do as well (but so far fell short on time ), is to release an sttp+openapi integration layer, starting by generating the request descriptions using OpenAPI-codegen. It doesn’t give you tapir endpoint descriptions, but you get sttp client request descriptions - not sure if that will be enough for your use-case?

Topic		Replies	Views
Explicit 'explode: true' in the generated OpenAPI tapir	4	237	September 20, 2023
Create Codec for NonEmptyList[String] tapir	1	183	May 9, 2023
List query parameter is not marked required? tapir	2	144	August 16, 2023
Json Schema from Tapir Schema tapir	5	198	April 13, 2023
Protobuf Enum to AsyncApi tapir	3	269	March 31, 2023

OpenAPI Codegen failing for "Given type is not array!"

Related Topics