OpenAPI - Improved resolving of database types to json data types #1568
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… converter used in OpenAPI doc creation.
… db type mapping to CLR(system) and JsonDataType/DbType. And added tests.
…tion in another pr.
seantleonard
requested review from
Aniruddh25,
JelteF,
Mathos1432,
aaronburtle,
aaronpowell,
abhishekkumams,
ayush3797,
gledis69,
mbhaskar,
milismsft,
ravishetye,
severussundar and
tarazou9
as code owners
aaronpowell
reviewed
Jul 6, 2023
src/Service.Tests/OpenApiDocumentor/CLRtoJsonValueTypeUnitTests.cs
Outdated
Show resolved
Hide resolved
src/Service.Tests/OpenApiDocumentor/CLRtoJsonValueTypeUnitTests.cs
Outdated
Show resolved
Hide resolved
|
Could you attach a screenshot of how the entity (which is attached in the issue) looks like now in swagger UI? |
….tryparse override used since latest syntax eliminates requirement to do null check and casting. Removed "DateTime" and "Time" from TypeHelper._systemTypeToDbTypeMap because they caused GraphQL type tests to fail because of exceptions converting from DateTimeOffset to DateTime. That issue may be fixed by #1473
Added before and after to the PR description |
Aniruddh25
reviewed
Jul 7, 2023
Aniruddh25
reviewed
Jul 7, 2023
aaronpowell
approved these changes
Jul 7, 2023
…value types to their underlying types, also adds comments to explain in tests and in engine code (TypeHelper)
…ght diffs that this PR actually contributes, as it doesn't change the whole file as github currently suggests. Updates TypeHelper dictionary to be defined by providing an enumerable of key/value pairs instead of indexer assignment.
…s://github.com/Azure/data-api-builder into dev/seantleonard/openapi_systemtojsondatatypes
Aniruddh25
reviewed
Jul 7, 2023
Aniruddh25
approved these changes
Jul 7, 2023
src/Service.Tests/OpenApiDocumentor/CLRtoJsonValueTypeUnitTests.cs
Outdated
Show resolved
Hide resolved
|
Does |
Aniruddh25
reviewed
Jul 7, 2023
Aniruddh25
requested changes
Jul 7, 2023
My bad, that was actually a default value (thanks for catching). A default value resolved by swagger UI based on the json data type. I added extra example of the raw openapi schema doc which shows the actual json data type resolved as a result of this change. (this requires extra click throughs in swagger to 'view schema'). |
…mTypeToDbTypeMap to avoid any possible regression.
Aniruddh25
approved these changes
Jul 10, 2023
…er unexpected sqldbtyp. Also updated configurationtests to not have single line namespace to accurately show changes.
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why make this change?
What is this change?
improves the mapping between SqlDbType <=> CLR/.NET Framwork (System) types <=> JsonDataType so that OpenApi document generation resolves the appropriate value types in REST endpoint result field value types and input (request body) field value types.
To view OpenApi document output, browse to the endpoint /swagger
Before (Swagger view with default values based on resolved JSON data type)
{ "value": [ { "typeid": 0, "byte_types": "string", "short_types": 0, "int_types": 0, "long_types": 0, "string_types": "string", "single_types": 0, "float_types": 0, "decimal_types": 0, "boolean_types": true, "date_types": "Unknown Type: undefined", "datetime_types": "Unknown Type: undefined", "datetime2_types": "Unknown Type: undefined", "datetimeoffset_types": "Unknown Type: undefined", "smalldatetime_types": "Unknown Type: undefined", "bytearray_types": "string", "guid_types": "string" } ] }After (Swagger view with default values based on resolved JSON data type)
{ "value": [ { "typeid": 0, "byte_types": "string", "short_types": 0, "int_types": 0, "long_types": 0, "string_types": "string", "single_types": 0, "float_types": 0, "decimal_types": 0, "boolean_types": true, "date_types": "string", "datetime_types": "string", "datetime2_types": "string", "datetimeoffset_types": "string", "smalldatetime_types": "string", "bytearray_types": "string", "guid_types": "string" } ] }After: OpenApi document json
How was this tested?