sngular / scc-multiapi-converter Goto Github PK

As a developer, I want to prepare and add the necessary files to the plugin for publishing to maven central.

have in count that the request schema has requirement properties.
api.txt

https://github.com/spring-cloud/spring-cloud-contract/milestone/89?closed=1

As a developer, I want to establish a suitable message for the automatic responses of the issues and the pull requests that are opened.

when compile multiapi contract with this api:

api.txt

It generates same names functions but with diferent contents.

When a pull request is merged into main:

• If it has the documentation tag, the wiki should be updated.
• If it has the release tag, a new release should be generated.

Adding both tags results in both actions being executed, and it would also be possible to merge without adding any of the two tags.

As a developer, I want to be able to use arrays as a structure to produce or consume in Kafka, since currently only objects are supported.

Recently we changed the package for the Maven Central Release but it doesn´t show that way in the Readme.md file.

We must change it so it´s the same in the readme file.

We must change the README.MD file, under the Writing Yamls section we must add an explanation on how the Parameter objects work, explaining that you can´t declare a parameter in a path Object and an Operation Object.

As a developer, I want the package to be distributed by maven central.

We must change the the groupId tag and the package in the repo for maven central in order to push the plugin over there and release it.

API Schemas specification support define a regex to define the String format. This regex should be used in the contract rather than the default one.

As a Developer, I want to be able to store schema contents in external files, so I can reuse it in other parts.

As a developer, I want the actions that are defined for the project to work with the forked repositories as well, so people can contribute with the project and don't receive an error from the actions.

Now, maven-pr action searchs for the HEAD commit reference inside the same repository and branch, and executes the jobs on that. This makes impossible the use of forked repos, so we need to address it.

Also, if this is possible, we must remove the execution of this action on push to main branch.

When this problem is solved, we must spread the solution to another projects with the same problem.

Hello,

I would like to understand how this library works. So I created a Spring-Boot project based on Spring-Boot 2.7.3 and Spring-Cloud 2021.0.3. As build tool I use Maven 3.8 and to configure the project properly I followed the instructions on your website. As API definition I used the OpenApi example from your website.

When I run the build I get the following error message:

Failed to execute goal org.springframework.cloud:spring-cloud-contract-maven-plugin:3.1.3:generateTests (default-generateTests) on project openapi-scc: Execution default-generateTests of goal org. springframework.cloud:spring-cloud-contract-maven-plugin:3.1.3:generateTests failed: Failed to convert file [C:\opt\ws\work\_openapi-scc\src\main\resources\api\openapi.yml]: Cannot invoke "io.swagger.v3.oas.models.media.Schema.getExample()" because "schema" is null -> [Help 1].

Am I doing something wrong? Is the example missing some things? Is the library having a bug?

The project where I had the problem can be found here:
https://github.com/ingogriebsch/_openapi-scc

As a developer, I want to have a check for the pom.xml version, to avoid errors during deployment stage.

We must analyze how to add a check for the version on PR, maybe including a new job/step on an existent workflow, or maybe adding a new workflow. This must check if the version is updated compared to the main branch, and if it's not, put a message on the PR including a link to the versioning system we are using, SemVer, so the contributor could solve the error.

When this problem is solved, we must spread the solution to another projects with the same problem, SCS Multiapi Plugin and KLoadGen.

api.txt

As of right now, SCC MultiApi Plugin only supports parameters in Operations.

We should develop a way to map the Parameters from the Path Object as well.

Here is an example of a parameter in a Path Object:

We should refactor the processRequest method in the OpenApiContractConverter to allow the usage of parameters in the PathObject

As a developer, I want to be able to support referencing objects within arrays via the $ref annotation.

Right now, the only way to reference objects in arrays is as follows:

And I want to add this way to reference them:

As a developer, I want to use the most update styles sheet and checkstyle, to mantain my project coherent with the other ones.

As a developer, I want to include in the README.md file the Maven Central badge.

In this issue we have to prepare everything related to release the plugin into Maven and have the correct github actions ready for the github release as well.

We need the following:

• Add the MPL header in every java file.
• Add the github actions folder and the necessary files for the release

As a developer, I want to be able to store the content of the schemas in external files, so that I can reuse it elsewhere.

Therefore, support must be added for referencing external files within yaml files.

As a developer, I would like to change the variables from the TestFixtures to protected in order to increase security

Update the plugin dependencies to the lastest version

Currently we are not supporting the definition of a simple array schema defined in OpenApi. This happens because we are missing a conditional clause.

As a developer I would like to address this issue and fix it.

As a developer, I want to fix all codacy issues related to asyncapi files.

As a developer, I want to be able to support referencing objects within arrays via the $ref annotation.

Right now, the only way to reference objects in arrays is as follows:

And I want to add this way to reference them:

Currently, SCC MultiApi does not support the creation of a contract when an array is referenced in a schema and has $ref inside of his items.

This happens inside the processBodyAndMatchers method because we check if the Schema has properties, but an array doesn´t, it has items. As you can see in line 199:

Check OpenApi Docs for this issue: https://swagger.io/docs/specification/data-models/data-types/

Integrate the SCC Verify AsyncApi Converter plugin to support messaging side contract generation.

Is there a possibility to use that library with the Gradle build tool?

As of right now, the logic behind the AnyOfs will create a N number of contracts that will come from the AnyOf´s list.

This creates a problem since the N number and the contract can changed based on the execution of the plugin, making it a lottery for a user to get the right contract at the right time.

As a team, we must review the logic behind this and change it to a behaviour that is manageable for a user.

As a developer, I want to be able to use arrays of references to components, to make the plugin as versatile as possible.

We must remove the ChangeLog Workflow for now. We might introduce it later