Shape Up đŸ‹ïžâ€â™€ïž

Visualize the progress we're making, one cycle at a time. Don't know what Shape Up is about? Learn more.

This cycle started on Mon Jan 18 2021 and finished on Mon Mar 01 2021.

Attention

This cycle has already finished.Go to the current cycle.

Figuring things outMaking it happen

History

the PR is ready to be reviewed, had some issues in regards to some examples values which were being generated did not match with the output. For now, the property name for a model is generated as is to be compliant with other tools.

Signatures should be stable. Any further improvements/bugs will be added/fixed in the library as issues - https://github.com/asyncapi/generator-model-sdk/issues

Maciej UrbaƄczyk
Updated progress of
Create and define the shape for the output model
to 100% ✹ on Fri Feb 26 2021
Maciej UrbaƄczyk
Updated progress of
Create and define the shape for the output model
to 100% ✹ on Fri Feb 26 2021

Output shape should be stable. Any further improvements/bugs will be added/fixed in the library as issues - https://github.com/asyncapi/generator-model-sdk/issues

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 100% ✹ on Thu Feb 25 2021
Maciej UrbaƄczyk
Updated progress of
Integrate the Java model generation into a library
to 80% on Wed Feb 24 2021

Render nested combined schemas.

Maciej UrbaƄczyk
Updated progress of
Integrate the Java model generation into a library
to 65% on Wed Feb 24 2021

Render nested enum.

Maciej UrbaƄczyk
Updated progress of
Integrate the Java model generation into a library
to 60% on Wed Feb 24 2021

Most have been integrated. I have to render by presets the nested enums, classes inside class etc ... is what we don't support in our library at the moment. PR is opened https://github.com/asyncapi/java-spring-template/pull/121

finished integration more or less https://github.com/asyncapi/ts-nats-template/pull/53. Currently waiting on some bug fixes from the model generation library.

started to look into integrating the tool into https://github.com/asyncapi/ts-nats-template

Jonas Lagoni
Updated progress of
Implement the transformation for JSON Schema to common model
to 100% ✹ on Tue Feb 23 2021
Jonas Lagoni
Updated progress of
Implement the transformation for JSON Schema to common model
to 100% ✹ on Tue Feb 23 2021

@magicmatatjahu PR with schema name inference is merged and the transformation of JSON Schemas are in a steady-state. Any further improvements will be added to the library as issues - https://github.com/asyncapi/generator-model-sdk/issues

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 90% on Tue Feb 23 2021

PR with docs is ready to review

Jonas Lagoni
Updated progress of
Implement the transformation for AsyncAPI to common model
to 100% ✹ on Mon Feb 22 2021
Jonas Lagoni
Updated progress of
Implement the transformation for AsyncAPI to common model
to 100% ✹ on Mon Feb 22 2021

further improvements will be added to the issue list in the library. The anonymous schema ids are inherited from the JSON Schema input processing so nothing needs to be changed there. Since JSON Schema is supported as input we will see if inputs for message, channel, operation is needed based on demand, for now it will not be included.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 100% ✹ on Mon Feb 22 2021
Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 100% ✹ on Mon Feb 22 2021

Implementation should be stable. Errors that occur during the integration will be reported to the generator-model-sdk repository.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Java
to 100% ✹ on Mon Feb 22 2021
Maciej UrbaƄczyk
Updated progress of
Create the basic model for Java
to 100% ✹ on Mon Feb 22 2021

Implementation should be stable. Errors that occur during the integration will be reported to the generator-model-sdk repository.

Open PR with simplification of schema's name

Maciej UrbaƄczyk
Updated progress of
[Feature] Integrate context in React renderer
to 100% ✹ on Wed Feb 17 2021
Maciej UrbaƄczyk
Updated progress of
[Feature] Integrate context in React renderer
to 100% ✹ on Wed Feb 17 2021

It won't be integrated in model-sdk, maybe in future as feature, but not now.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 80% on Mon Feb 15 2021

Integrate presets in basic TS/JS models: class, interface, enum.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Java
to 80% on Mon Feb 15 2021

Integrate presets in basic Java models: class and enum.

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 80% on Mon Feb 15 2021

PR with presets is merged. Start writing docs.

Jonas Lagoni
Updated progress of
Implement the transformation for AsyncAPI to common model
to 75% on Mon Feb 15 2021

AsyncAPI input processing we now also have the information about extend to enable easy inheritance. Next is to support multiple AsyncAPI inputs such as message, channel, operation etc. Further we need to add better anonymous schema ids and the simplifier needs to use those it gets from the parser.

JSON Schema now fully supports circular schemas, we now also has the information about extend to enable easy inheritance. Other then that all there is left for JSON Schema simplification is to give them correct identifiers/names for anonymous schemas.

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 65% on Thu Feb 11 2021

PR is opened. Ready to review.

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 50% on Wed Feb 10 2021

Customisation applied. Start writing tests.

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 20% on Tue Feb 09 2021

Add PR with first draft to show how customization could look in our sdk - https://github.com/asyncapi/generator-model-sdk/pull/39

Maciej UrbaƄczyk
Updated progress of
Add customization process
to 5% on Mon Feb 08 2021

Start the task

Maciej UrbaƄczyk
Updated progress of
Create and define the shape for the output model
to 90% on Mon Feb 08 2021

Shape is stable. If we change it in development process, we'll inform about that in this issue. Task will be opened until the end of the cycle.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 70% on Mon Feb 08 2021

Generator and renderers for TS and JS types are almost done. I will add mix/extend, required etc. functionality when simplification process will be completed.

Signatures are stable. If we change them in development process, we'll inform about that in this issue. Task will be opened until the end of the cycle.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Java
to 50% on Sun Feb 07 2021

Add class and enum (for string and integer type) renderer for Java types

reviewed the processes and added simplified methods so we have single point of entry regardless of whether you want to generate something using a pure JSON schema or an entire AsyncAPI file. The input processor for JSON Schema now supports references which are resolved before the simplification stage.

Jonas Lagoni
Updated progress of
Create and define the shape for common input model
to 100% ✹ on Thu Feb 04 2021
Jonas Lagoni
Updated progress of
Create and define the shape for common input model
to 100% ✹ on Thu Feb 04 2021

this is considered done. Any extra improvements or changes will be added to the issues of the library itself which can be found here

Jonas Lagoni
Updated progress of
Implement the transformation for AsyncAPI to common model
to 60% on Thu Feb 04 2021

Processing AsyncAPI as either an object already parsed by the parser library or as a basic JS object is now supported.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Java
to 20% on Wed Feb 03 2021

Add basic class renderer for Java in this PR https://github.com/asyncapi/generator-model-sdk/pull/27

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 50% on Wed Feb 03 2021

Add generators for TS and JS types and make renderers for Enum, Interface, Class types.

Finished item simplification and waiting for review https://github.com/asyncapi/generator-model-sdk/pull/18

Properties are done

Looks like our approach is correct, enum and type simplification are merged. Up next is properties and items.

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 30% on Mon Feb 01 2021

Create first draft for TS/JS generator in this Pr https://github.com/asyncapi/generator-model-sdk/pull/20

Maciej UrbaƄczyk
Updated progress of
Create the basic model for Javascript/Typescript
to 5% on Fri Jan 29 2021

Starting implementation of basic model for Javascript/Typescript. I need wait to other task to go with it, so I will base impl. on mocks and then switch to processor flow.

Signatures for generation and transformation (input processing) are merged. We leave some time in next weeks (next tasks) to check if given signatures are friendly to developer, if no, we will slighty change them.

starting to push the limits of what JSON Schema should be used for in terms of it being a constraint language and us using it to determine type definitions. However enum simplification are done, next I gotta look at how we can simplify overall schemas. I suspect that we might need to add allOf keyword into CommonSchema since multiple types for arrays and objects are at the moment not supported.

roughly defined the how types are simplified, next is enumerators.

Jonas Lagoni
Updated progress of
Create and define the shape for common input model
to 99% on Mon Jan 25 2021

finished defining basic input models and their setup, need to revise the documentation for the input process.

have started to define how types are supposed to be simplified

Maciej UrbaƄczyk
Updated progress of
Create and define the shape for the output model
to 50% on Mon Jan 25 2021

Add output model shape and corresponding tests. I will think if the model is correct when implementing languages ​​and then I will change it if necessary.

started to look at the different transformations and simplification steps we need to perform for the common model.

Jonas Lagoni
Updated progress of
Create and define the shape for common input model
to 75% on Fri Jan 22 2021

defined basic models and started setting up the process interactions.

Jonas Lagoni
Updated progress of
Create and define the shape for common input model
to 45% on Thu Jan 21 2021

Figured most of the things out how to depict the common input model, still got a hanging issue regarding the structure and use of something like CommonModel instead of Schema. We also added the initial repository for the model generation.

Maciej UrbaƄczyk
Updated progress of
[Feature] Integrate context in React renderer
to 40% on Wed Jan 20 2021

I was able to create a context similar to React (in this PR https://github.com/asyncapi/generator-react-sdk/pull/19), but however I don't have any idea how to properly handle parallel case to speed up generation process. I'll postpone this task when we'll start implementation of model generation for Java/Typescript.

Jonas Lagoni
Updated progress of
Create and define the shape for common input model
to 15% on Tue Jan 19 2021

started and trying to figure out the optimal shape to use as a common model for rendering. So fare it actually seems like using simplified JSON schema behind the scenes are the best solution.