Skip to content

Commit

Permalink
#47 Added explanation for Parameters (#48)
Browse files Browse the repository at this point in the history
  • Loading branch information
Rivarsal authored Jun 13, 2022
1 parent fd45d4e commit fe16920
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ After you have these installed, you need to add the Spring Cloud Contract Maven
<dependency>
<groupId>net.coru</groupId>
<artifactId>scc-multiapi-converter</artifactId>
<version>2.4.0</version>
<version>2.4.1</version>
<scope>compile</scope>
</dependency>
</dependencies>
Expand All @@ -58,7 +58,10 @@ If you need more control over the settings of your project, you can use all the

This plugin supports most of the OpenApi/Swagger and AsyncApi, but there are a couple of things that must be noted:

- Using **OpenApi/AsyncApi´s example label** in the parameters/schemas will check in our contracts that the response is equal to the example value instead of using a Regex.
- Using **OpenApi/AsyncApi´s example label** in the parameters/schemas will check in our contracts that the response is equal to the example
value instead of using a Regex.
- **OpenApi**: Since 2.4.0 version, we support the definition of parameters in both Path and Operation object, but you can only define it
in one of them. If you specify them in both objects it will trigger an Exception.
- Please be aware that writing an example must be the same type as indicated in the file, otherwise your contract will break.

This is an easy example of a small YAML for OpenApi that will work with our plugin:
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<groupId>net.coru</groupId>
<artifactId>scc-multiapi-converter</artifactId>
<version>2.4.0</version>
<version>2.4.1</version>
<name>SCC-MultiApi-Converter</name>
<description>Generates Spring Cloud Contracts based on an OpenApi and AsyncApi document</description>
<url>https://github.com/corunet/scc-multiapi-converter</url>
Expand Down

0 comments on commit fe16920

Please sign in to comment.