Blocking issue: oas tool 3 failed to handle optional field in schema as optional.

[cll023]

The following is my testing OAS API spec:

openapi: 3.0.2
info:
  title: OAS Tool Test TEST
  description: test purpose
  version: "0.1.0"
servers:
  - url: http://localhost:8000/v1


paths:
  /test:
    post:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestDocument'
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/testPostResponse'
      operationId: postTest
      x-router-controller: TestController
components:
  schemas:
    TestDocument:
      type: object
      required:
      - version
      - id
      properties:
        version:
          description: Schema version
          type: string
        id:
          description: Unique ID
          type: string
          example: 1234567
        owner:
          $ref: '#/components/schemas/Owner'
    Owner:
      type: object
      required:
        - id
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          minLength: 1
          maxLength: 256
    testPostResponse:
      description: Uploaded Test
      type: object
      properties:
        status:
          type: string
          enum:
            - Success
            - Fail
          example: Success
        data:
          type: object
      required:
        - status
        - data

The following is main program:

const http = require('http');
const express = require("express");
const { initialize } = require('@oas-tools/core');


const serverPort = 8000;
const app = express();
app.use(express.json({limit: '50mb'}));

const config = {
    middleware: {
        validator: {
            strict: true,
            requestValidation: true,
            responseValidation: true,
        },
    }
}


initialize(app, config).then(() => {
    http.createServer(app).listen(serverPort, () => {
    console.log("\nApp running at http://localhost:" + serverPort);
    console.log("________________________________________________________________");
    if (config.middleware.swagger?.disable !== false) {
        console.log('API docs (Swagger UI) available on http://localhost:' + serverPort + '/docs');
        console.log("________________________________________________________________");
    }
    });
});

With the above configuration, if I issue POST v1/test with the following JSON body:
{
"version": "string",
"id": "1234567"
}

I got 404 with the following response body:
{
"error": "RequestValidationError: Request body does not match the schema specified in the OAS Document:\n- Validation failed at #/properties/owner/required > must have required property 'id'"
}

oas Tool3 failed to recognize that "owner" is an optional filed. And after the following code
if (oasRequest.requestBody) {
const contentType = Object.keys(oasRequest.requestBody.content)[0];
body = schema.parseBody(body, oasRequest.requestBody.content[contentType].schema);
}
It sets owner as {}. Thus it fails the schema validation.

This is a blocking issue that prevent me from upgrading oas tool 3.

Could someone take a look at this issue? Thank you!

Sorry I don't know how to preserve the format of the YAML file when posting, but hope it still gets the idea crossed.

[alesancor1]

Issue created at oas-tools/oas-tools#356.

@cll023 To make a code block and insert yaml/javascript or whatever language you want just enclose your code with ```. Like this:

     ```yaml (set to the preferred language, e.g: python, javascript)

        your:
           yamlFile:
               - here
      ```

Hope it helps :)

[cll023]

Thanks for the info. I made the change so it is easier to read/copy.