Improve support `@constraint:String {}` annotation mapping to OpenAPI Spec #1546

SachinAkash01 · 2023-09-25T05:00:21Z

Add support for mapping Ballerina String constraints to the OpenAPI specification.
Modify the unit tests to ensure the accuracy & reliability of @constraint:String {} mapping to OpenAPI spec.
This ensures that String constraints in Ballerina are accurately reflected in OpenAPI spec.

Resolves: #4813
See also: #4788

… Spec - Add support for mapping Ballerina String constraints to the OpenAPI specification. - Modify the unit tests to ensure the accuracy & reliability of `@constraint:String {}` mapping to OpenAPI spec. - This ensures that String constraints in Ballerina are accurately reflected in OpenAPI spec. Resolves: [#4813](ballerina-platform/ballerina-library#4813) See also: [#4788](ballerina-platform/ballerina-library#4788)

codecov · 2023-09-25T06:51:14Z

Codecov Report

Attention: 11 lines in your changes are missing coverage. Please review.

Comparison is base (27259f2) 79.92% compared to head (858fd56) 79.98%.
Report is 40 commits behind head on constraint_support.

Additional details and impacted files

@@                   Coverage Diff                    @@
##             constraint_support    #1546      +/-   ##
========================================================
+ Coverage                 79.92%   79.98%   +0.06%     
- Complexity                 1825     1841      +16     
========================================================
  Files                       125      125              
  Lines                     10265    10301      +36     
  Branches                   1698     1699       +1     
========================================================
+ Hits                       8204     8239      +35     
- Misses                     1469     1475       +6     
+ Partials                    592      587       -5

Files	Coverage Δ
...java/io/ballerina/openapi/converter/Constants.java	`73.86% <ø> (ø)`
...enapi/converter/diagnostic/DiagnosticMessages.java	`100.00% <100.00%> (ø)`
...penapi/converter/service/ConstraintAnnotation.java	`100.00% <100.00%> (ø)`
...napi/converter/service/OpenAPIComponentMapper.java	`89.69% <90.43%> (+0.22%)`	⬆️

... and 1 file with indirect coverage changes

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

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/string.bal

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/string.bal

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalRec.bal

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/floatRec.bal

…/decimalRec.bal Co-authored-by: Sumudu Nissanka <lnash94@users.noreply.github.com>

…/floatRec.bal Co-authored-by: Sumudu Nissanka <lnash94@users.noreply.github.com>

…napi-tools into constraint_s_s

openapi-bal-service/src/main/java/io/ballerina/openapi/converter/Constants.java

openapi-cli/src/test/java/io/ballerina/openapi/generators/openapi/NegativeConstraintTests.java

…api/NegativeConstraintTests.java Co-authored-by: Ayesh Almeida <77491511+ayeshLK@users.noreply.github.com>

openapi-bal-service/src/main/java/io/ballerina/openapi/converter/Constants.java

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/arrayRec.bal

...api-cli/src/test/resources/ballerina-to-openapi/constraint/negative_patternInterpolation.bal

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java

…/arrayRec.bal Co-authored-by: Sumudu Nissanka <lnash94@users.noreply.github.com>

sonarqubecloud · 2023-10-17T17:56:09Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

SachinAkash01 requested review from hevayo, NipunaRanasinghe and lnash94 as code owners September 25, 2023 05:00

Add unit tests

1aaa59a

Nuvindu reviewed Sep 25, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/string.bal Outdated Show resolved Hide resolved

Fix line spaces

530742e

lnash94 reviewed Sep 25, 2023

View reviewed changes

Resolve suggested changes

88ae2a3

SasinduDilshara reviewed Sep 26, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/string.bal Show resolved Hide resolved

SasinduDilshara reviewed Sep 26, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/string.bal Show resolved Hide resolved

SachinAkash01 added 18 commits September 27, 2023 04:14

Add record type constraint mapping

353134f

Fix Ubuntu build issue

4c924c3

Add unit tests for constraint record types

c3a756d

Add new line space

1c05aac

Improve regex support

890ea97

Add suggested changes

7e4e8bc

Fix build issues

6ffb883

Test case for pattern interpolations

597f54e

Fix line space

8b2c7a9

Handle interpolation in REGEX patterns

cf8df49

Change variable names according to naming conventions

ceabf56

Fix interpolation patterns

58b2e9b

Improve tests for interpolation in regex

eb3b5a0

Improve CHECK_INTERPOLATION pattern

41edbf9

Reduce security hotspots

67297b6

Improve diagnostic

4b61beb

Improve regex patterns

260aba0

Improve security in REGEX patterns

0af8813

lnash94 reviewed Oct 11, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

lnash94 reviewed Oct 11, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/decimalRec.bal Outdated Show resolved Hide resolved

lnash94 reviewed Oct 11, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/floatRec.bal Outdated Show resolved Hide resolved

SachinAkash01 and others added 8 commits October 11, 2023 11:37

Update openapi-cli/src/test/resources/ballerina-to-openapi/constraint…

2a10557

…/decimalRec.bal Co-authored-by: Sumudu Nissanka <lnash94@users.noreply.github.com>

Update openapi-cli/src/test/resources/ballerina-to-openapi/constraint…

123e8a6

…/floatRec.bal Co-authored-by: Sumudu Nissanka <lnash94@users.noreply.github.com>

Fix reviewed changes

3af7830

Merge branch 'constraint_s_s' of https://github.com/SachinAkash01/ope…

5949344

…napi-tools into constraint_s_s

Improve diagnostic messages

74a4a36

Update constraint tests

f50c1b8

Update Schema properties with relevant schema types

7f610bf

Fix whitespace

e96e3f9

ayeshLK reviewed Oct 13, 2023

View reviewed changes

openapi-bal-service/src/main/java/io/ballerina/openapi/converter/Constants.java Outdated Show resolved Hide resolved

SachinAkash01 added 5 commits October 13, 2023 10:12

Fix suggested changes

b8bda1b

Fix build issues

42ebe86

Naming files with proper format

f68caac

Add negative test for REGEX patterns

e42ddda

Fix whitespace error

a3ef54d

ayeshLK reviewed Oct 17, 2023

View reviewed changes

openapi-cli/src/test/java/io/ballerina/openapi/generators/openapi/NegativeConstraintTests.java Outdated Show resolved Hide resolved

Update openapi-cli/src/test/java/io/ballerina/openapi/generators/open…

3d4a7ee

…api/NegativeConstraintTests.java Co-authored-by: Ayesh Almeida <77491511+ayeshLK@users.noreply.github.com>

SasinduDilshara reviewed Oct 17, 2023

View reviewed changes

openapi-bal-service/src/main/java/io/ballerina/openapi/converter/Constants.java Show resolved Hide resolved

SachinAkash01 mentioned this pull request Oct 17, 2023

[Ballerina to OpenAPI] Support REGEX Patterns which Include $ Literal Character in String Constraints ballerina-platform/ballerina-library#5048

Open

lnash94 reviewed Oct 17, 2023

View reviewed changes

openapi-cli/src/test/resources/ballerina-to-openapi/constraint/arrayRec.bal Outdated Show resolved Hide resolved

lnash94 reviewed Oct 17, 2023

View reviewed changes

...api-cli/src/test/resources/ballerina-to-openapi/constraint/negative_patternInterpolation.bal Outdated Show resolved Hide resolved

lnash94 reviewed Oct 17, 2023

View reviewed changes

...bal-service/src/main/java/io/ballerina/openapi/converter/service/OpenAPIComponentMapper.java Outdated Show resolved Hide resolved

SachinAkash01 and others added 2 commits October 17, 2023 23:02

Update openapi-cli/src/test/resources/ballerina-to-openapi/constraint…

4608845

…/arrayRec.bal Co-authored-by: Sumudu Nissanka <lnash94@users.noreply.github.com>

Fix suggested changes

858fd56

lnash94 approved these changes Oct 18, 2023

View reviewed changes

ayeshLK merged commit b4c4c6a into ballerina-platform:constraint_support Oct 18, 2023
5 checks passed

ayeshLK mentioned this pull request Oct 19, 2023

Map Ballerina String Constraints to OpenAPI Specification ballerina-platform/ballerina-library#4813

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve support `@constraint:String {}` annotation mapping to OpenAPI Spec #1546

Improve support `@constraint:String {}` annotation mapping to OpenAPI Spec #1546

SachinAkash01 commented Sep 25, 2023 •

edited

Loading

codecov bot commented Sep 25, 2023 •

edited

Loading

sonarqubecloud bot commented Oct 17, 2023

Improve support @constraint:String {} annotation mapping to OpenAPI Spec #1546

Improve support @constraint:String {} annotation mapping to OpenAPI Spec #1546

Conversation

SachinAkash01 commented Sep 25, 2023 • edited Loading

codecov bot commented Sep 25, 2023 • edited Loading

Codecov Report

sonarqubecloud bot commented Oct 17, 2023

Improve support `@constraint:String {}` annotation mapping to OpenAPI Spec #1546

Improve support `@constraint:String {}` annotation mapping to OpenAPI Spec #1546

SachinAkash01 commented Sep 25, 2023 •

edited

Loading

codecov bot commented Sep 25, 2023 •

edited

Loading