Index (shadow-api-detector 3.7.1 API)

A C D F G N S T U W
All Classes and Interfaces|All Packages|Constant Field Values

A

apply(Project) - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin
applyCleanupDsl(boolean) - Method in class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: Sets getCleanupDsl() for this run only.
applyFailOnShadowOverride(boolean) - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: CLI entry point for DetectShadowApisTask.getFailOnShadowOverride().
applyGenerateDsl(boolean) - Method in class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: Sets getGenerateDsl() for this run only.
applyScanForShadows(String) - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: CLI entry point for DetectShadowApisTask.getScanForShadows().
applyUpdateContractHistoryOverride(boolean) - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: CLI entry point for DetectShadowApisTask.getUpdateContractHistoryOverride().

C

com.arc_e_tect.gradle.shadow - package com.arc_e_tect.gradle.shadow
com.arc_e_tect.gradle.shadow.detect - package com.arc_e_tect.gradle.shadow.detect
com.arc_e_tect.gradle.shadow.report - package com.arc_e_tect.gradle.shadow.report

D

DEFAULT_CONTRACT_HISTORY_FILE_NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Default name of the persisted contract progress history file.
DEFAULT_CONTROLLER_DIR - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Default relative path of the directory searched for @RestController classes.
DEFAULT_REPORT_FILE_NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Default name of the generated AsciiDoc report file.
Defaults - Search tag in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Section
DetectShadowApisTask - Class in com.arc_e_tect.gradle.shadow: Gradle task that scans @RestController classes, compares the endpoints they expose against the configured OpenAPI documentation, and writes an AsciiDoc report of every endpoint that is not described - the "shadow APIs".
DetectShadowApisTask() - Constructor for class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Creates the task.

F

findShadows(List<Endpoint>, List<DescribedEndpoint>) - Method in class com.arc_e_tect.gradle.shadow.detect.ShadowApiFinder: Returns every endpoint in endpoints that has no matching entry in described.

G

generate() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Task action: either scans a single controller named or pathed by DetectShadowApisTask.getScanForShadows() and prints its findings to the console (see DetectShadowApisTask.scanSingleController(String)), or - when that property is unset - scans every @RestController class under DetectShadowApisTask.getControllerDirs(), loads the configured OpenAPI documentation, and writes the shadow API report.
getBuildFile() - Method in class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: The build file to update - the project's own build.gradle.
getCleanupDsl() - Method in class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: Strips every comment line from inside the managed block - both pre-existing ones and any doc comment this run would otherwise add - leaving only properties.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: File that the persisted contract progress history is read from and, when DetectShadowApisTask.getUpdateContractHistory() is true, written back to.
getContractHistoryFile() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: File that the persisted contract progress history is read from and, when ShadowApiDetectorExtension.getUpdateContractHistory() is true, written back to.
getContractHistoryFilePath() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: The absolute path of DetectShadowApisTask.getContractHistoryFile(), tracked as a plain @Input value - not the file's content, which DetectShadowApisTask.getContractHistoryFile() itself is deliberately excluded from up-to-date checking for.
getControllerDirs() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Directories to search recursively for @RestController classes.
getControllerDirs() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Directories to search recursively for @RestController classes.
getExcludeFiles() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: External exclusion rule files - see ShadowApiDetectorExtension.getExcludeFiles().
getExcludeFiles() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: One or more YAML files of exclusion rules, in the same format bundled well-known sets use:
getExcludePaths() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Exclusion rule strings - see ShadowApiDetectorExtension.getExcludePaths().
getExcludePaths() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Exclusion rule strings, parsed by ExclusionRule.parse(String) - e.g.
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Bundled well-known exclusion set names - see ShadowApiDetectorExtension.getExcludeWellKnown().
getExcludeWellKnown() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Names of bundled, well-known exclusion sets to apply - e.g.
getFailOnShadow() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Whether the build should fail when shadow APIs are found.
getFailOnShadow() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Whether the build should fail when shadow APIs are found.
getFailOnShadowOverride() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Single-run override of DetectShadowApisTask.getFailOnShadow(), settable only from the command line via --failOnShadow/--no-failOnShadow - never wired from the DSL, and unset by default.
getGenerateDsl() - Method in class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: When the shadowApiDetector block is entirely absent, synthesize a full new one from the schema and append it to the end of the build file; when false (the default), a missing block is left alone.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Directory where OpenAPI descriptions are stored, tracked so that changes to any document reachable from DetectShadowApisTask.getRootDocument() invalidate the task's cached result.
getOpenApiDir() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Directory where OpenAPI descriptions are stored.
getProjectDirectory() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: The project directory, used only to resolve a relative DetectShadowApisTask.getScanForShadows() path against - never against this process's own working directory, which need not be the project directory at all (e.g.
getReportDir() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Directory the AsciiDoc report is written to.
getReportDir() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Directory the AsciiDoc report is written to.
getReportFileName() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Name of the generated AsciiDoc report file (without path).
getReportFileName() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Name of the generated AsciiDoc report file (without path).
getRootDocument() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: The root OpenAPI document describing the API.
getRootDocument() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: The root OpenAPI document describing the API.
getScanForShadows() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: The name or path of a single @RestController class to scan for shadow APIs, settable only from the command line via --scanForShadows=<name-or-path> - never wired from the DSL, and unset by default.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Version of the system under test whose @RestController classes were scanned, printed in the generated report as e.g.
getSystemUnderTestVersion() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Version of the system under test whose @RestController classes are scanned, printed in the generated report as e.g.
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Whether to persist, across builds, a history of when each endpoint first reached each stage of its contract lifecycle - declared, implemented, verified.
getTrackContractHistory() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Whether to persist, across builds, a history of when each endpoint first reached each stage of its contract lifecycle - declared, implemented, verified - keyed by a fingerprint of its HTTP verb and path so the history is shared correctly with Mirage and Doppelganger API Detector when they're pointed at the same ShadowApiDetectorExtension.getContractHistoryFile().
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Whether DetectShadowApisTask.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.
getUpdateContractHistory() - Method in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Whether ShadowApiDetectorExtension.getContractHistoryFile() is written back to disk after being updated with the current run's endpoints.
getUpdateContractHistoryOverride() - Method in class com.arc_e_tect.gradle.shadow.DetectShadowApisTask: Single-run override of DetectShadowApisTask.getUpdateContractHistory(), settable only from the command line via --updateContractHistory/--no-updateContractHistory - never wired from the DSL, and unset by default.

N

NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Extension DSL block name, i.e.

S

ShadowApiDetectorExtension - Class in com.arc_e_tect.gradle.shadow: DSL extension for the Shadow API Detector Gradle plugin.
ShadowApiDetectorExtension() - Constructor for class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: For use by the Gradle-generated concrete subclass.
ShadowApiDetectorPlugin - Class in com.arc_e_tect.gradle.shadow: Gradle plugin that registers the detectShadowApis and updateShadowApiDetectorDSL tasks and wires the shadowApiDetector DSL extension into the project.
ShadowApiDetectorPlugin() - Constructor for class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Creates a new plugin instance.
ShadowApiFinder - Class in com.arc_e_tect.gradle.shadow.detect: Determines which controller Endpoints are not described by any DescribedEndpoint collected from the OpenAPI documentation, i.e.
ShadowApiFinder() - Constructor for class com.arc_e_tect.gradle.shadow.detect.ShadowApiFinder: Creates a new ShadowApiFinder.
ShadowApiReportWriter - Class in com.arc_e_tect.gradle.shadow.report: Writes the AsciiDoc shadow API report: every @RestController endpoint that is not described in the configured OpenAPI documentation.
ShadowApiReportWriter() - Constructor for class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Creates a new ShadowApiReportWriter.

T

TASK_NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Name of the Gradle task registered by this plugin.

U

UPDATE_DSL_TASK_NAME - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Name of the DSL-updating task registered by this plugin.
updateDsl() - Method in class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: Reads the build file, adds any missing DSL properties, and writes it back if anything changed - after first copying the original, untouched file alongside it as build.gradle.bak, so there's always a plain-file fallback even for a project not using version control (or one that just hasn't committed the file yet).
UpdateShadowApiDetectorDslTask - Class in com.arc_e_tect.gradle.shadow: Adds any shadowApiDetector DSL properties missing from this project's build file, set to their default values - see com.arc_e_tect.gradle.dslupdater.DslUpdater and ShadowApiDetectorDslSchema.
UpdateShadowApiDetectorDslTask() - Constructor for class com.arc_e_tect.gradle.shadow.UpdateShadowApiDetectorDslTask: Creates a new task instance.
Usage - Search tag in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorPlugin: Section

W

write(File, int, List<Endpoint>, String) - Method in class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<Endpoint>, String, List<String>, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<Endpoint>, String, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.
write(File, int, List<Endpoint>, List<Endpoint>, String, List<String>, Map<String, ContractProgressRecord>) - Method in class com.arc_e_tect.gradle.shadow.report.ShadowApiReportWriter: Writes the report to outputFile, creating its parent directory if necessary.

A C D F G N S T U W
All Classes and Interfaces|All Packages|Constant Field Values