📘 OpenAPI/Swagger-generated API Reference Documentation
This report summarizes scanner evidence for Redocly/redoc, a TypeScript project with 25,994 GitHub stars. SynthScan examined 139,620 lines of code across 1024 source files, recording 184 pattern matches distributed across 5 syntactic categories. The legacy adjusted pattern signal is 1.5 (Low pattern signal); it is not an authorship estimate.
Use the findings to ask whether maintainers can explain intent, verify dependencies, simplify unnecessary scaffolding, and focus review effort. Risk Payload v1 adds ownership, supply-chain, over-engineering, and review-effort vectors when available. These are prompts for human verification, not probabilities, security findings, or measured maintenance costs.
Use each vector to guide manual verification of the underlying findings.
Payload schema: 1.0.0 · Engine: 2.0.0 · Scoring: heuristic-density-v1 · Scan date: 2026-10-31.
Can maintainers explain intent, assumptions, and trade-offs? 160 finding(s).
Are imports declared and package/API names verified? 16 finding(s).
Are wrappers, guards, and repeated structures necessary? 166 finding(s).
Which changes need focused human review? 184 finding(s).
This chart tracks the legacy adjusted pattern score across scan runs. Changes can reflect source changes, scan coverage, or detector/scoring versions; they do not measure AI adoption or prove that a team refactored code. Compare runs only when their scoring versions are compatible. The dashed line tracks the raw pattern-hit count.
Groups findings by configured severity weight. Severity is not a confidence estimate, security rating, or proof that a package is missing. Verify imports against the project's manifests and inspect each finding in its local design context.
This horizontal bar chart shows where configured pattern scores accumulate across directories. Treat the bars as locations to inspect, not as evidence of authorship or code quality. Use the file-level findings to decide whether a directory needs a focused ownership, dependency, complexity, or review check.
The scanner identified 184 distinct pattern matches across 5 syntactic categories. Each entry below represents a discrete location in the source code where the engine recorded a detector match to inspect in context. Expand any category row to inspect the individual file paths, line numbers, code snippets, and the lexical context (CODE, COMMENT, or STRING) in which each match was detected.
Reading the findings table: The Severity column indicates the configured finding weight (CRITICAL / HIGH / MEDIUM / LOW). The Context column identifies whether the match occurred inside executable code, an inline comment, or a string literal — legacy comment-context matches receive a ×1.5 score weight. The ⚡ bolt icon marks clustered matches: three or more patterns within a 10-line window, each receiving an additional ×1.5 density multiplier under the legacy scoring model.
| Severity | File | Line | Snippet | Context |
|---|---|---|---|---|
| LOW | e2e/playwright/ce/tests/telemetry.spec.ts | 19 | async function renderThenForceTelemetryFlush(page: Page, query: string): Promise<void> { | CODE |
| LOW | e2e/playwright/ce/examples/global-setup.ts | 87 | async function assertInstalledFromTarball(example: Example): Promise<void> { | CODE |
| LOW | src/options/helpers.ts | 125 | export function normalizeIgnoreNamedSchemas( | CODE |
| LOW | src/utils/deep-link.ts | 109 | export function buildOpenApiSectionSuffix( | CODE |
| LOW | src/utils/deep-link.ts | 192 | export function isGraphqlDeepLinkAncestor(hash: string, path: string): boolean { | CODE |
| LOW | src/utils/deep-link.ts | 269 | export function extractDeepLinkParamFromHash( | CODE |
| LOW | src/utils/string.ts | 64 | export function transformStringToTelemetryId(...args: string[]): string { | CODE |
| LOW | src/utils/scroll-anchoring.ts | 11 | export function keepReadingSectionAnchored(): void { | CODE |
| LOW | src/utils/graphql-directive-utils.ts | 24 | export function getRequiresScopesDirective(type: DirectiveTarget): RequiresScopesDirective | null { | CODE |
| LOW | src/utils/graphql-directive-utils.ts | 46 | function extractScopesFromDirective(directive: DirectiveNode): string[][] | null { | CODE |
| LOW | src/utils/graphql-directive-utils.ts | 56 | function extractStringArrayFromValue(value: ValueNode): string[][] | null { | CODE |
| LOW | src/utils/graphql-directive-utils.ts | 72 | export function extractInfoFromDirectives(schema: GraphQLSchema): GraphQLInfo | undefined { | CODE |
| LOW | src/utils/media-type.ts | 40 | export function normalizeLanguageForHighlight(language: string | undefined): string { | CODE |
| LOW | src/utils/media-type.ts | 51 | export function isFormUrlEncodedMediaType(contentType: string | undefined): boolean { | CODE |
| LOW | src/utils/graphql-samples.ts | 319 | export function generateOperationVariablesExample( | CODE |
| LOW | src/utils/graphql-samples.ts | 331 | export function generateOperationResponseExample( | CODE |
| LOW | src/utils/graphql-type-expansion.ts | 23 | export function graphqlTypeHasExpandableFields( | CODE |
| LOW | src/utils/__tests__/graphql-samples.test.ts | 16 | function multilineForSamplesMaxInlineArgs(argCount: number, samplesMaxInlineArgs: number): boolean { | CODE |
| LOW | src/adapters/helpers.ts | 88 | export function pickRenderableDescription(value: unknown): ExampleEntry['description'] { | CODE |
| LOW | src/adapters/asyncapi/panels/overview.ts | 6 | export function buildOverviewPanelContent(info: AsyncApiInfo): OverviewNode { | CODE |
| LOW | src/adapters/asyncapi/panels/download.ts | 6 | export function buildDownloadPanelContent(downloadUrls: NormalizedDownloadUrl[]): DownloadNode { | CODE |
| LOW | src/adapters/asyncapi/utils/security.ts | 91 | export function buildSecurityRequirements( | CODE |
| LOW | src/adapters/asyncapi/utils/get-protocol-labels.ts | 73 | export function componentLabelsByProtocol({ protocol, channelBindings }: Params): Options { | CODE |
| LOW | src/adapters/asyncapi/items/channel/item.ts | 19 | function resolveChannelLabelAndSeo( | CODE |
| LOW | src/adapters/asyncapi/items/channel/item.ts | 31 | function buildSortedOperationsWithGroupHeaders( | CODE |
| LOW | src/adapters/asyncapi/items/channel/content.ts | 53 | export function buildMessageReferencesGroups( | CODE |
| LOW | src/adapters/utils/markdoc.ts | 38 | function contentUntilFirstAtxHeading(source: string): string { | CODE |
| LOW | src/adapters/utils/markdoc.ts | 43 | export function extractContentUntilFirstHeading( | CODE |
| LOW | src/adapters/utils/markdoc.ts | 82 | export function extractDescriptionSegments( | CODE |
| LOW | src/adapters/utils/markdoc.ts | 135 | export function resolveMarkdocHeadingDeepSuffix( | CODE |
| LOW | src/adapters/utils/markdoc.ts | 380 | function buildSectionItemWithChildren( | CODE |
| LOW | src/adapters/utils/markdoc.ts | 451 | export function extractFirstParagraphText( | CODE |
| LOW | src/adapters/openapi/build-code-sample-source.ts | 119 | function buildParametersByLocation( | CODE |
| LOW | src/adapters/openapi/build-code-sample-source.ts | 211 | function buildSecurityRequirements( | CODE |
| LOW | src/adapters/openapi/resolve-openapi-example-value.ts | 3 | export function resolveOpenApiExampleValue(example: OpenAPIExample | undefined): unknown { | CODE |
| LOW | src/adapters/openapi/store.ts | 27 | function normalizeImplicitDiscriminators(document: OpenAPIDefinition): void { | CODE |
| LOW | src/adapters/openapi/panels/overview.ts | 6 | export function buildOverviewPanelContent(info: OpenAPIInfo | undefined): OverviewNode { | CODE |
| LOW | src/adapters/openapi/panels/download.ts | 6 | export function buildDownloadPanelContent(downloadUrls: NormalizedDownloadUrl[]): DownloadNode { | CODE |
| LOW | src/adapters/openapi/utils/resolvePathItemRef.ts | 6 | function openapiAllowsPathItemRefSiblings(openapi: string | undefined): boolean { | CODE |
| LOW | …/adapters/openapi/utils/applyIgnoreNamedSchemasDeep.ts | 4 | export function applyIgnoreNamedSchemasDeep( | CODE |
| LOW | …apters/openapi/__tests__/callback-descriptions.test.ts | 24 | function documentWithCallbackDescription(description: string): OpenAPIDefinition { | CODE |
| LOW | …apters/openapi/__tests__/callback-descriptions.test.ts | 50 | function documentWithTwoUrlExpressions(): OpenAPIDefinition { | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 409 | function buildCallbackOperationSection( | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 501 | function buildCallbackPayloadPanels( | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 636 | function buildResponseHeadersSchema( | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 696 | function normalizeOpenApiDescription(value: unknown): string | Node | Node[] | undefined { | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 752 | function resolveOpenApiExamplesMap( | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 1180 | function buildOperationSecuritySection(operationInfo: OperationInfo): SecurityNode | undefined { | CODE |
| LOW | src/adapters/openapi/items/operation/content.ts | 1233 | function buildCodeSampleSourceFromContext( | CODE |
| LOW | src/adapters/openapi/items/schema/content.ts | 7 | export function buildSchemaDefinitionContent( | CODE |
| LOW | …dapters/openapi/items/schema/__tests__/content.test.ts | 24 | function findSchemaDefinitionMarkdoc(content: ApiItemContent): MarkdocNode | undefined { | CODE |
| LOW | src/adapters/__tests__/validateContentLinks.ts | 109 | function assertMessageReferenceLink( | CODE |
| LOW | src/adapters/graphql/serializeType.ts | 44 | function createDescriptionSerializer( | CODE |
| LOW | src/adapters/graphql/serializeType.ts | 79 | export function createGraphqlTypeSerializer( | CODE |
| LOW | src/adapters/graphql/group/errors.ts | 1 | export function getItemDoesNotMatchAnyGroupErrorMessage(itemDescription: string): string { | CODE |
| LOW | src/adapters/graphql/panels/group-items.ts | 10 | export function buildGroupItemsPanelContent( | CODE |
| LOW | src/adapters/graphql/panels/overview.ts | 6 | export function buildOverviewPanelContent( | CODE |
| LOW | src/adapters/graphql/panels/download.ts | 6 | export function buildDownloadPanelContent( | CODE |
| LOW | src/adapters/graphql/utils/validateMenuConfig.ts | 6 | export function validateGraphqlMenuConfig(schema: GraphQLSchema, menuConfig?: MenuConfig): void { | CODE |
| LOW | src/adapters/graphql/utils/configMetadataRows.ts | 23 | export function buildGraphqlConfigMetadataRows( | CODE |
| 98 more matches not shown… | ||||
| Severity | File | Line | Snippet | Context |
|---|---|---|---|---|
| LOW | playground/specs/cafe.yaml | 1532 | hyphens, and apostrophes (e.g., "John Doe", "Mary-Jane", "O'Brien"). | CODE |
| LOW | …tests/schema/schema-streaming-response-samples.spec.ts | 23 | `{"id":"user_123","name":"John Doe","email":"john.doe@example.com","active":true}`, | CODE |
| LOW | …tests/schema/schema-streaming-response-samples.spec.ts | 45 | `{"id":"user_123","profile":{"name":"John Doe","email":"john.doe@example.com","preferences":{"theme":"dark","n | CODE |
| LOW | …tests/schema/schema-streaming-response-samples.spec.ts | 59 | `{"type":"user_created","userId":"user_123","timestamp":"2024-01-15T10:00:00Z","data":{"name":"John Doe","emai | CODE |
| LOW | …tests/schema/schema-streaming-response-samples.spec.ts | 78 | `{"id":"string","name":"string","email":"user@example.com","active":true}`, | CODE |
| LOW | …tests/schema/schema-streaming-response-samples.spec.ts | 100 | `{"id":"string","profile":{"name":"string","email":"user@example.com","preferences":{"theme":"light","notifica | CODE |
| LOW | src/utils/__tests__/__fixtures__/openapi-3-1.yaml | 698 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor | CODE |
| LOW | src/utils/__tests__/__fixtures__/openapi-3-1.yaml | 698 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor | CODE |
| LOW | …pters/__tests__/__fixtures__/specs/openapi/schema.yaml | 702 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor | CODE |
| LOW | …pters/__tests__/__fixtures__/specs/openapi/schema.yaml | 702 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor | CODE |
| LOW | …hema/views/__tests__/PropertyFieldRow.example.test.tsx | 47 | street: '123 Main Street', | CODE |
| LOW | …ices/code-samples/__tests__/streaming-pipeline.test.ts | 99 | name: { type: 'string', example: 'John Doe' }, | CODE |
| LOW | …ices/code-samples/__tests__/streaming-pipeline.test.ts | 135 | '{"id":"user_123","profile":{"name":"John Doe","email":"john.doe@example.com","preferences":{"theme":"dark","notif | CODE |
| LOW | …ices/code-samples/__tests__/streaming-pipeline.test.ts | 151 | name: { type: 'string', example: 'John Doe' }, | CODE |
| LOW | …ices/code-samples/__tests__/streaming-pipeline.test.ts | 185 | '{"type":"user_created","userId":"user_123","timestamp":"2024-01-15T10:00:00Z","data":{"name":"John Doe","email":" | CODE |
| LOW | src/services/search/__tests__/engine.test.ts | 420 | const text = `${'lorem ipsum dolor '.repeat(15)}wombat${' sit amet consectetur'.repeat(15)}`; | CODE |
| Severity | File | Line | Snippet | Context |
|---|---|---|---|---|
| MEDIUM | src/utils/deep-link.ts | 7 | // ── Low-level primitives ──────────────────────────────────────────────────── | COMMENT |
| MEDIUM | src/utils/deep-link.ts | 68 | // ── OpenAPI suffix builders ───────────────────────────────────────────────── | COMMENT |
| MEDIUM | src/utils/deep-link.ts | 124 | // ── AsyncAPI suffix builders ──────────────────────────────────────────────── | COMMENT |
| MEDIUM | src/utils/deep-link.ts | 159 | // ── GraphQL suffix builders ───────────────────────────────────────────────── | COMMENT |
| MEDIUM | src/utils/deep-link.ts | 364 | // ── Legacy hash helpers (for scroll) ──────────────────────────────────────── | COMMENT |
| Severity | File | Line | Snippet | Context |
|---|---|---|---|---|
| HIGH | examples/java/Main.java | 0 | <!doctype html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, init | STRING |
| HIGH | …rc/main/java/com/example/cafedocs/RedocController.java | 0 | <!doctype html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, init | STRING |
| HIGH | examples/aspnet/Program.cs | 0 | <!doctype html> <html lang="en"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, init | STRING |
| Severity | File | Line | Snippet | Context |
|---|---|---|---|---|
| LOW | config/docker/docker-run.sh | 1 | #!/bin/sh | COMMENT |
| LOW | src/empty-linkedom.js | 1 | // Browser-bundle stub for `linkedom` (see vite.config.ts). | COMMENT |