Add ApiSpecFetcher for Fetching and Comparing API Specifications by junweid62 · Pull Request #900 · opensearch-project/flow-framework

junweid62 · 2024-10-04T16:41:58Z

Description

Introduced a new ApiSpecFetcher utility to programmatically fetch and compare OpenAPI specifications.
Supports comparing required input fields between an OpenAPI spec and predefined enum values.
The current implementation serves as a foundational mechanism, with the comparison logic successfully integrated into the Register Agent workflow.
Future PRs will extend this mechanism to other workflow steps, ensuring consistent validation across the API specification.

Related Issues

Part of #651

Check List

New functionality includes testing.
New functionality has been documented.
API changes companion pull request created.
Commits are signed per the DCO using --signoff.
Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Junwei Dai <junweid@amazon.com>

codecov · 2024-10-04T16:47:42Z

Codecov Report

Attention: Patch coverage is 84.44444% with 7 lines in your changes missing coverage. Please review.

Project coverage is 78.10%. Comparing base (7a93d6c) to head (af15a00).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
.../opensearch/flowframework/util/ApiSpecFetcher.java	82.05%	4 Missing and 3 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #900      +/-   ##
============================================
+ Coverage     78.04%   78.10%   +0.06%     
- Complexity      977      990      +13     
============================================
  Files            97       99       +2     
  Lines          4554     4599      +45     
  Branches        423      428       +5     
============================================
+ Hits           3554     3592      +38     
- Misses          823      827       +4     
- Partials        177      180       +3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Junwei Dai <junweid@amazon.com>

dbwiddis

Looks great! A few suggestions you can take or leave; only thing I'd insist on changing before approval is the too-broad throwing of Exception.

CHANGELOG.md

build.gradle

src/main/java/org/opensearch/flowframework/exception/ApiSpecParseException.java

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java

src/test/java/org/opensearch/flowframework/util/ApiSpecFetcherTests.java

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java

owaiskazi19

Great start!

src/main/java/org/opensearch/flowframework/exception/ApiSpecParseException.java

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java

src/test/java/org/opensearch/flowframework/workflow/RegisterAgentTests.java

Signed-off-by: Junwei Dai <junweid@amazon.com>

dbwiddis

A few more tweaks.

build.gradle

src/main/java/org/opensearch/flowframework/common/CommonValue.java

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java

src/test/java/org/opensearch/flowframework/exception/ApiSpecParseExceptionTests.java

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java

Signed-off-by: Junwei Dai <junweid@amazon.com>

dbwiddis

Approving with a few last items to clean up

src/test/java/org/opensearch/flowframework/util/ApiSpecFetcherTests.java

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java

Signed-off-by: Junwei Dai <junweid@amazon.com>

build.gradle

* Added ApiSpecFetcher with test Signed-off-by: Junwei Dai <junweid@amazon.com> * remove duplication license Signed-off-by: Junwei Dai <junweid@amazon.com> * Add more test to pass test coverage check Signed-off-by: Junwei Dai <junweid@amazon.com> * new commit address all comments Signed-off-by: Junwei Dai <junweid@amazon.com> * new commit address all comments Signed-off-by: Junwei Dai <junweid@amazon.com> * Addressed all comments Signed-off-by: Junwei Dai <junweid@amazon.com> --------- Signed-off-by: Junwei Dai <junweid@amazon.com> Co-authored-by: Junwei Dai <junweid@amazon.com> (cherry picked from commit 57b8b59) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

…ifications (#906) * Add ApiSpecFetcher for Fetching and Comparing API Specifications (#900) * Added ApiSpecFetcher with test Signed-off-by: Junwei Dai <junweid@amazon.com> * remove duplication license Signed-off-by: Junwei Dai <junweid@amazon.com> * Add more test to pass test coverage check Signed-off-by: Junwei Dai <junweid@amazon.com> * new commit address all comments Signed-off-by: Junwei Dai <junweid@amazon.com> * new commit address all comments Signed-off-by: Junwei Dai <junweid@amazon.com> * Addressed all comments Signed-off-by: Junwei Dai <junweid@amazon.com> --------- Signed-off-by: Junwei Dai <junweid@amazon.com> Co-authored-by: Junwei Dai <junweid@amazon.com> (cherry picked from commit 57b8b59) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> * Add slf4j-api and jackson-core dependencies Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Junwei Dai <junweid@amazon.com> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Signed-off-by: Daniel Widdis <widdis@gmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Junwei Dai <junweid@amazon.com> Co-authored-by: Daniel Widdis <widdis@gmail.com>

Added ApiSpecFetcher with test

f2a0c4e

Signed-off-by: Junwei Dai <junweid@amazon.com>

junweid62 requested review from amitgalitz, dbwiddis, jackiehanyang, joshpalis, ohltyler and owaiskazi19 as code owners October 4, 2024 16:41

github-actions bot added the backport 2.x backport PRs to 2.x branch label Oct 4, 2024

remove duplication license

65b5303

Signed-off-by: Junwei Dai <junweid@amazon.com>

Add more test to pass test coverage check

87a23a9

Signed-off-by: Junwei Dai <junweid@amazon.com>

dbwiddis reviewed Oct 5, 2024

View reviewed changes

owaiskazi19 reviewed Oct 7, 2024

View reviewed changes

junweid62 and others added 2 commits October 7, 2024 11:43

Merge branch 'main' into api-consistency-test

6329da9

new commit address all comments

8f0010f

Signed-off-by: Junwei Dai <junweid@amazon.com>

dbwiddis reviewed Oct 7, 2024

View reviewed changes

owaiskazi19 reviewed Oct 7, 2024

View reviewed changes

src/main/java/org/opensearch/flowframework/util/ApiSpecFetcher.java Show resolved Hide resolved

new commit address all comments

f021ef8

Signed-off-by: Junwei Dai <junweid@amazon.com>

dbwiddis approved these changes Oct 8, 2024

View reviewed changes

Addressed all comments

af15a00

Signed-off-by: Junwei Dai <junweid@amazon.com>

owaiskazi19 reviewed Oct 8, 2024

View reviewed changes

build.gradle Show resolved Hide resolved

owaiskazi19 approved these changes Oct 8, 2024

View reviewed changes

owaiskazi19 merged commit 57b8b59 into opensearch-project:main Oct 8, 2024

opensearch-trigger-bot bot mentioned this pull request Oct 8, 2024

[Backport 2.x] Add ApiSpecFetcher for Fetching and Comparing API Specifications #906

Merged

junweid62 mentioned this pull request Oct 8, 2024

[FEATURE] Implement API Consistency Tests for Remaining Workflow Steps #908

Closed

7 tasks

owaiskazi19 mentioned this pull request Oct 9, 2024

Force tests jackson dependencies to 2.18 #911

Merged

5 tasks

junweid62 deleted the api-consistency-test branch December 27, 2024 18:33

dbwiddis mentioned this pull request Apr 29, 2025

Add Junwei Dai as a maintainer #1133

Merged

1 task

Conversation

junweid62 commented Oct 4, 2024

Description

Related Issues

Check List

Uh oh!

codecov bot commented Oct 4, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

dbwiddis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

owaiskazi19 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbwiddis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dbwiddis left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Oct 4, 2024 •

edited

Loading

dbwiddis left a comment •

edited

Loading