WithMappingFromOpenApiFile fails with exception when example item present in text-plain response in OAS contract #681

New Issue

2025-12-29T15:30:45+01:00

adam commented

2025-12-29 15:30:45 +01:00

Originally created by @TomRom27 on GitHub (Apr 4, 2025).

Originally assigned to: @StefH on GitHub.

Description

OpenAPI content response can be of different types, plain text amongst others, like below:

        "responses": {
          "200": {
            "description": "Ok: The request has succeeded",
            "content": {
              **"text/plain; charset=utf-8": {**
                "schema": {
                  "type": "string",
                  **"example": "This is an example for 200"**
                }
              }
            }
          }
        }

Microsoft's OpenApiStreamReader imports it without any problem and thus we can see example item in this case is represented as simple string

But WithMappingFromOpenApiFile fails and raises exception:
"Error reading JObject from JsonReader. Current JsonReader item is not an object: String. Path '', line 1, position 28."

Looks like inside MapOperationToMappingModel it fails to handle the responseExample - if it is simple string.

Expected behavior

OAS contract with example item for text-plain can be used for mappings.

Test to reproduce

run WithMappingFromOpenApiFile on a file with example in response of plain-text type - use attached file.

oas-content-example.json

Other related info

Originally created by @TomRom27 on GitHub (Apr 4, 2025). Originally assigned to: @StefH on GitHub. ### Description OpenAPI content response can be of different types, plain text amongst others, like below: ``` yml "responses": { "200": { "description": "Ok: The request has succeeded", "content": { **"text/plain; charset=utf-8": {** "schema": { "type": "string", **"example": "This is an example for 200"** } } } } } ``` Microsoft's OpenApiStreamReader imports it without any problem and thus we can see example item in this case is represented as simple string ![Image](https://github.com/user-attachments/assets/fc9bc86d-d03a-44bc-9c37-27ce11bb6bc3) But WithMappingFromOpenApiFile fails and raises exception: "Error reading JObject from JsonReader. Current JsonReader item is not an object: String. Path '', line 1, position 28." Looks like inside MapOperationToMappingModel it fails to handle the responseExample - if it is simple string. ### Expected behavior OAS contract with example item for text-plain can be used for mappings. ### Test to reproduce - run WithMappingFromOpenApiFile on a file with example in response of plain-text type - use attached file. [oas-content-example.json](https://github.com/user-attachments/files/19601002/oas-content-example.json) ### Other related info

adam closed this issue

2025-12-29 15:30:45 +01:00

adam commented

2025-12-29 15:30:46 +01:00