Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Issue/1175/improve open api final 2 #1224

Open
wants to merge 46 commits into
base: main
Choose a base branch
from
Open

Issue/1175/improve open api final 2 #1224

wants to merge 46 commits into from

Conversation

tschlat
Copy link
Collaborator

@tschlat tschlat commented Oct 5, 2024 •
edited
Loading

This is the final PR for the new OpenAPI feature.

I apologize for the large size of this PR. It includes the following major changes:

  1. Updates to the OpenAPI Connector:
  • Improved test coverage.
  • Replaced validation using "Citrus Control Message" with OAS schema validation based on the Atlassian OpenAPI Validator framework. (This is quite a drastical change and I would appreciate Christophs Feedback on this). I am pretty sure that this is breaking, as the OpenAPI Validator might be stricter than the previous implementation.
  • Enhanced random message generation capabilities and test coverage
  1. Revised Implementation of TestAPI Generator:
  • Now uses the Citrus Builder Pattern.
  • Added extensive tests to verify the generated test API against various aspects of OpenAPI.
  • Introduced multipartmessage support.
  • Included support for all different types of parameter serialization.
  • Added an initial implementation of a SOAP Test API generator. While the benefits of this API are somewhat limited, it becomes useful when OpenAPI and SOAP are used together, as both service types can now be handled in a consistent way. Note: the SOAP Test API is in an early stage, with basic functionality and limited testing.
  • org.citrusframework.openapi.generator.GeneratedRestApiIT gives an overview on how to use the generated REST API
  • org.citrusframework.openapi.generator.GeneratedSoapApiIT same for SOAP although only very little, yet
  1. Enhanced Server-Side Header Validation for Parameter Serialization:
  • Improved header validation to support arrays of parameters, particularly focusing on different aspects of array-type parameter serialization.
  • see org.citrusframework.http.message.HttpQueryParamHeaderValidator for details

This was referenced Oct 5, 2024
Closed
Closed
Closed
@tschlat tschlat force-pushed the issue/1175/improve_open_api_final_2 branch 2 times, most recently from 31731e3 to 7b85d6a Compare October 5, 2024 17:58
@tschlat tschlat requested review from bbortt and christophd October 5, 2024 18:07
@bbortt bbortt force-pushed the issue/1175/improve_open_api_final_2 branch 2 times, most recently from af4b223 to 18ae70b Compare October 21, 2024 14:42
bbortt added a commit that referenced this pull request Oct 23, 2024
@bbortt
chore(citrus-openapi): pr review and code cleanup
c565059 
pr: #1224

`citrus-openapi` module.
bbortt added a commit that referenced this pull request Oct 23, 2024
@bbortt
chore(citrus-openapi): pr review and code cleanup
cce754e 
pr: #1224

`citrus-openapi` module.
bbortt added a commit that referenced this pull request Oct 23, 2024
@bbortt
chore(citrus-api): review and code cleanup
0e463de 
pr: #1224

`citrus-api` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-openapi): review and code cleanup
42ce36a 
pr: #1224

`citrus-openapi` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-api): review and code cleanup
0f41890 
pr: #1224

`citrus-api` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-base): review and code cleanup
800d702 
pr: #1224

citrus-base` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-spring): review and code cleanup
bc1a818 
pr: #1224

`citrus-spring` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-spring): review and code cleanup
53d09e0 
pr: #1224

`citrus-spring` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-http): review and code cleanup
875c8c4 
pr: #1224

`citrus-http` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-jms): review and code cleanup
fa0f5a3 
pr: #1224

`citrus-jms` module.
bbortt added a commit that referenced this pull request Oct 24, 2024
@bbortt
chore(citrus-rmi): review and code cleanup
19c13af 
pr: #1224

`citrus-rmi` module.
bbortt added a commit that referenced this pull request Oct 26, 2024
@bbortt
chore(citrus-http): review and code cleanup
749aaeb 
pr: #1224

`citrus-http` module.
bbortt added a commit that referenced this pull request Oct 26, 2024
@bbortt
chore(citrus-jms): review and code cleanup
601955a 
pr: #1224

`citrus-jms` module.
bbortt added a commit that referenced this pull request Oct 26, 2024
@bbortt
chore(citrus-rmi): review and code cleanup
bfa1315 
pr: #1224

`citrus-rmi` module.
bbortt added a commit that referenced this pull request Oct 26, 2024
@bbortt
chore(citrus-test-api-core): review and code cleanup
f638d79 
pr: #1224

`citrus-test-api-core` module.
@bbortt bbortt added State: To discuss In case there are open questions concerning the issue Type: Feature Prio: High State: Review If pull-request has been opened an is ready/in review labels Oct 28, 2024
bbortt added a commit that referenced this pull request Oct 28, 2024
@bbortt
chore(citrus-openapi): review and code cleanup
e8afc7b 
pr: #1224

`citrus-openapi` module.
bbortt and others added 29 commits January 27, 2025 07:07
@bbortt
fix: pom structure
2928fdd
@bbortt
chore(citrus-openapi): review and code cleanup
211cd75 
pr: #1224

`citrus-openapi` module.
@bbortt
chore(citrus-api): review and code cleanup
51fd755 
pr: #1224

`citrus-api` module.
@bbortt
chore(citrus-base): review and code cleanup
79d0fbb 
pr: #1224

citrus-base` module.
@bbortt
chore(citrus-spring): review and code cleanup
2ff6a59 
pr: #1224

`citrus-spring` module.
@bbortt
chore(citrus-http): review and code cleanup
b7505ac 
pr: #1224

`citrus-http` module.
@bbortt
chore(citrus-jms): review and code cleanup
27e112d 
pr: #1224

`citrus-jms` module.
@bbortt
chore(citrus-rmi): review and code cleanup
b5741f5 
pr: #1224

`citrus-rmi` module.
@bbortt
docs(#1175): review
f6cca64
@bbortt
chore(citrus-test-api-core): review and code cleanup
872d263 
pr: #1224

`citrus-test-api-core` module.
@bbortt
chore(citrus-test-api-generator-core): review and code cleanup
be8563a 
pr: #1224

`citrus-test-api-generator-core` module.
@bbortt
chore(citrus-test-api-generator-maven-plugin): review and code cleanup
2ff3b0d 
pr: #1224

`citrus-test-api-generator-maven-plugin` module.
@bbortt
chore(citrus-test-api-spring): review and code cleanup
0359e6a 
pr: #1224

`citrus-test-api-spring` module.
@bbortt
chore(citrus-validation): review and code cleanup
203262d 
pr: #1224

`citrus-validation` module and sub-modules.
@bbortt
ci: fix citrus java codegen test with root folder
b5aeaa3
@bbortt
feat: changes on open api feature due to first beta tests
7363bf9
@bbortt
chore: bump maven reactor to 4.5.0-SNAPSHOT
2a981c7
@bbortt
feat: changes on open api feature due to first beta tests
41c7282
@bbortt
feat: changes on open api feature due to first beta tests
98bb758
@bbortt
feat: add option to specify OpenApiValidationPolicy
bf7ec14
@bbortt
chore: fix test errors
e10f1cc
@bbortt
fix: accept only json and plain text for random message generation
ea0f4f3
@bbortt
fix: adjust paths for code generation according to CodeGenMojo
3554ce7 
Use:
- generated-(test)-sources/openapi/src/main/java
- generated-(test)-sources/openapi/src/main/resources
- generated-(test)-sources/openapi/src/main/resources/META-INF (as default for spring artefacts)
@bbortt
chore: bump all versions to 4.6.0-SNAPSHOT
2939207
@bbortt
fix: treat unparsable server urls as non existent
29bd033 
- depending on configuration server urls are not really required
- fix expected code gen for generated api test
@bbortt
fix(api): add logger message to OpenApiSchemaValidation for httpMessa…
9fd16a5 
…ges to name the path of origin
@bbortt
fix(api): rename the message variable to httpMessage because a type c…
40ee800 
…ast took place
@bbortt
fix(api): redo the formatting as it was
1d7c2e1
@bbortt
fix: add draft open api documentation
955c5fc
@bbortt bbortt force-pushed the issue/1175/improve_open_api_final_2 branch from a304689 to 955c5fc Compare January 27, 2025 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bbortt bbortt bbortt requested changes

@christophd christophd Awaiting requested review from christophd

Assignees

@tschlat tschlat

Labels
Prio: High State: Review If pull-request has been opened an is ready/in review State: To discuss In case there are open questions concerning the issue Type: Feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tschlat @bbortt