import * as React from 'react';
import { InteractiveSection } from './InteractiveSection';
import { OpenAPIOperationData } from './fetchOpenAPIOperation';
import { generateSchemaExample } from './generateSchemaExample';
import { OpenAPIContextProps } from './types';
import { createStateKey, noReference } from './utils';
import { stringifyOpenAPI } from './stringifyOpenAPI';
import { OpenAPIV3 } from '@scalar/openapi-types';
/**
* Display an example of the response content.
*/
export function OpenAPIResponseExample(props: {
data: OpenAPIOperationData;
context: OpenAPIContextProps;
}) {
const { data, context } = props;
// if there are no responses defined for the operation
if (!data.operation.responses) {
return null;
}
const responses = Object.entries(data.operation.responses);
// Sort response to get 200, and 2xx first
responses.sort(([a], [b]) => {
if (a === 'default') {
return 1;
}
if (b === 'default') {
return -1;
}
if (a === '200') {
return -1;
}
if (b === '200') {
return 1;
}
return Number(a) - Number(b);
});
const examples = responses
.map(([key, value]) => {
const responseObject = noReference(value);
const mediaTypeObject = (() => {
if (!responseObject.content) {
return null;
}
return (
responseObject.content['application/json'] ??
responseObject.content[Object.keys(responseObject.content)[0]]
);
})();
if (!mediaTypeObject) {
return null;
}
const example: OpenAPIV3.ExampleObject | null = noReference(
(() => {
const { examples, example } = mediaTypeObject;
if (examples) {
const firstKey = Object.keys(examples)[0];
// @TODO handle multiple examples
const firstExample = noReference(examples[firstKey]);
if (firstExample) {
return firstExample;
}
}
if (example) {
return { value: example };
}
const schema = noReference(mediaTypeObject.schema);
if (!schema) {
return null;
}
return { value: generateSchemaExample(schema) };
})(),
);
if (!example?.value) {
return null;
}
return {
key: key,
label: key,
body: (
),
};
})
.filter((val): val is { key: string; label: string; body: any } => Boolean(val));
if (examples.length === 0) {
return null;
}
return (
);
}