Enhancement: Add More Spec Details to the UI

[aerfus]

Describe the feature request
Primitive types have no payload information displayed,
minimum and maximum values are absent in UI.

Additional information
A type badge is added to payload header

Resolves #378

[github-actions]

Welcome to Springwolf. Thanks a lot for creating your first pull request. Please check out our contributors guide and feel free to join us on discord.

[timonback]

Hi @aerfus
I like the code changes (incl ng template) and how the data is presented to the user.

A couple things/questions:

1. To fix the formatting, you can run gradle spotlessaApply
2. the AsyncAPI.json file is generated by Springwolf through the code. There should be a Size annotation for a class property or similar that will result in the minimum/maximum field in the spec.
3. Same thing with the primitives, which you probably added for demo purposes. And then underlying issue being that the ui side has no test coverage. If you want to investigate how to add angular ui tests, you are very welcome. Otherwise, adding a single string Kafka consumer for the Kafka example would be sufficient from my side
4. Since us maintainers also stumble upon the ignoreWhitespaces: Did you had trouble getting the tests running/passing?

Great work!

[aerfus]

Hi @timonback ,

As for the remarks:

1. Formatting is fixed
2. Done
3. Done.
   Yes, those examples were for the demonstration. So I've removed them.
4. Yes, I'm using Windows OS and have .gitattributes file present.
   Still the generated fixture has Windows line endings, which results in test failures.

[aerfus]

Let me investigate angular ui tests.
For that I'll create a separate issue and PR.

[timonback]

@aerfus Can you check if there is a way to assert the schemas, while keeping a line ending?
For example: assertThat(actualDefinitions).isEqualToNormalizingNewlines(expected);

Does the ApiSystemTest in the example fail as well? If not, maybe the files json files in core have been checked in with the wrong line ending.

[aerfus]

Hi @timonback ,

I've made a little research.
ApiSystemTest does no fail as it uses restTemplate, which returns JSON with '\n' line endings.
All the fixture resources involved also have '\n' line endings.

The problem occurs when we use DefaultAsyncApiSerializerService and in my case it sets '\r\n'.
I've managed to force it using '\n' and tests are now passing.

Should I rewrite tests using isEqualToNormalizingNewlines or changing CustomPrettyPrinter is okay?

Preview:

Before

        public CustomPrettyPrinter() {
            super._arrayIndenter = new DefaultIndenter();
            super._objectFieldValueSeparatorWithSpaces = _separators.getObjectFieldValueSeparator() + " ";
        }

After

        public CustomPrettyPrinter() {
            super._arrayIndenter = new DefaultIndenter();
            super._objectFieldValueSeparatorWithSpaces = _separators.getObjectFieldValueSeparator() + " ";
            super._objectIndenter = new DefaultIndenter().withLinefeed("\n");
            super._arrayIndenter = new DefaultIndenter().withLinefeed("\n");
        }

Before

new DefaultPrettyPrinter().withObjectIndenter(new DefaultIndenter("  ", DefaultIndenter.SYS_LF));

After

new DefaultPrettyPrinter().withObjectIndenter(new DefaultIndenter("  ", "\n"));

[jenarp]

Hi @aerfus,
this looks good so far, thank you for your effort. :-)
What I am missing is to distinguish between exclusive and inclusive max and mins, i.e. bigger equal (>=) vs. bigger (>) and the same with lower.
Do you see a chance to add such behaviour. In Swagger it is possible to distinguish between these annotations: exclusiveMinimum/exclusiveMaximum and just minimum/maximum (which is inclusive by default).

[timonback]

@aerfus Let's do the following:

I revert the commit that improves development under windows and we move that to a separate PR. I prefer the idea of isEqualToNormalizingNewlines as it only touches test code and not production. To test it, you can also open a PR against your own fork, then I do not have to approve Github actions to run.

Running git ls-files --eol shows on my system that (almost) all files are checked in as lf as it should be on my system. I am happy to check and debug further with you together.

Why merge now?
It simplifies our preparation for AsyncApi 3.0 and I want to avoid merge/rebase conflicts.