oas
Version:
Comprehensive tooling for working with OpenAPI definitions
53 lines (51 loc) • 1.77 kB
text/typescript
interface OASAnalysisFeature {
locations: string[];
present: boolean;
}
interface OASAnalysisGeneral {
found: string[] | number;
name: string;
}
interface OASAnalysis {
general: {
mediaTypes: OASAnalysisGeneral;
operationTotal: OASAnalysisGeneral;
securityTypes: OASAnalysisGeneral;
};
openapi: {
additionalProperties: OASAnalysisFeature;
callbacks: OASAnalysisFeature;
circularRefs: OASAnalysisFeature;
commonParameters: OASAnalysisFeature;
discriminators: OASAnalysisFeature;
links: OASAnalysisFeature;
polymorphism: OASAnalysisFeature;
serverVariables: OASAnalysisFeature;
style: OASAnalysisFeature;
webhooks: OASAnalysisFeature;
xml: OASAnalysisFeature;
};
readme: {
/**
* RAW_BODY is specific to our Manual API editor and we don't recommend anyone writing their
* own API definition should use it so this is considered deprecated.
*/
raw_body?: OASAnalysisFeature;
'x-default': OASAnalysisFeature;
/**
* x-readme-ref-name is added by our tooling after dereferencing so our UI can display the
* reference name.
*/
'x-readme-ref-name': OASAnalysisFeature;
'x-readme.code-samples': OASAnalysisFeature;
'x-readme.explorer-enabled': OASAnalysisFeature;
'x-readme.headers': OASAnalysisFeature;
'x-readme.proxy-enabled': OASAnalysisFeature;
/**
* This extension is deprecated.
*/
'x-readme.samples-enabled'?: OASAnalysisFeature;
'x-readme.samples-languages'?: OASAnalysisFeature;
};
}
export type { OASAnalysis, OASAnalysisFeature, OASAnalysisGeneral };