Cannot read property 'type' of null when linting OpenAPI files

[ibm]

Cannot read property 'type' of null when linting OpenAPI files

[mkistler]

At the point of this processing, I don't believe we have a filename to print. This code is operating on a resolvedSchema, meaning a schema where references have already been resolved.

But there may be a clue that can help find the problem. The code that failed looks like this:

  const arrayPathsToOctetSequence = [];
  const arrayItems = resolvedSchema.items;
  if (arrayItems !== undefined) {
    // supports both array and string (delimited by .) paths
    const pathToSchema = Array.isArray(path)
      ? path.concat('items')
      : `${path}.items`;
    if (arrayItems.type === 'string' && arrayItems.format === 'binary') {

The last line is the line that failed, attempting to reference type of arrayItems. You see just above that the code checks arrayItems !== undefined, but does not check for null. So this suggests that somewhere in your API doc there is an items: null. Maybe. Worth looking for.

[distortedsignal]

I was just about to tag somebody in the PR, but I see that there is activity on this ticket. I'll hold my peace for now.

[dpopp07]

@jorge-ibm was @mkistler going to work on this? If not, @distortedsignal, we would welcome the PR!

[jorge-ibm]

Yes I think @mkistler was going to take a look, but I agree. @distortedsignal if you have a PR for this already please feel free to submit it

[distortedsignal]

I sent a PR to add the path to the exception text. I figure the best way to report to the user that their OpenAPI spec is not valid is to point them to where the invalid spec is. Check out the PR here: #190

[dpopp07]

Resolved in #190

@distortedsignal Let me know if that PR doesn't fully resolve the issue. Thanks for the PR!

[distortedsignal]

I think the PR resolves the issue enough. It will at least tell you where the data types are that are causing the issue. This is as much as can be asked for when dealing with faulty API documentation.