fix: get response example return type

[mskri]

🧰 Changes

Hey 👋 I was using the library and noticed that the getResponseExamples() declares to use incorrect type. The returned data is not in the shape the type definition claims.

The function casts the returned type incorrectly in L68. The used type is shaped like

type ResponseExamples = {
  mediaTypes: Record<string, RMOAS.MediaTypeObject>;
  status: string;
}[];

but the code actually transforms it into type shaped like

interface MediaTypeExample {
  description?: string;
  summary?: string;
  title?: string;
  value: unknown;
}

The actually used type is defined in L28 which is then returned from the getResponseExamples() in L56.

The type is also missing onlyHeaders?: boolean which is added conditionally in L57.

Taking a look at the tests
for getResponseExamples() reveals that the mediaTypes type is expected to be Record<string, MediaTypeExample[]> instead of Record<string, RMOAS.MediaTypeObject>. The used tests data doesn't conform to RMOAS.MediaTypeObject's shape.

🧬 QA & Testing

Since the change is about the types there wasn't any changes to the existing tests. The tests ran green before the change and after change.

[erunion]

oh great catch! thank you so much.

[erunion]

Published to 20.10.3.