Index (shadow-api-detector 1.4.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

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: scans the configured controller directories, loads the configured OpenAPI documentation, writes the shadow API report, and - when DetectShadowApisTask.getFailOnShadow() is true - fails the build if any shadow API was found.
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.
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.
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.
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.
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.

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 task 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_CONTRACT_HISTORY_OVERRIDE_PROPERTY - Static variable in class com.arc_e_tect.gradle.shadow.ShadowApiDetectorExtension: Name of the Gradle project property that overrides ShadowApiDetectorExtension.getUpdateContractHistory() from the command line for every project in the build, e.g.
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, 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