symbol / symbol-openapi-generator

Generates and deploys OpenAPI generated client libraries for Symbol SDKs

Symbol Monorepo

In Q1 2021, we consolidated a number of projects into this repository. It includes our specialized binary payload DSL (parser and schemas), clients and sdks.

component	lint	build	test	coverage	package
@catbuffer/parser
@client/catapult
@client/rest
@sdk/javascript
@sdk/python
@linters
@jenkins

Full Coverage Report

Detailed version can be seen on codecov.io.

symbol-openapi-generator's Issues

Remove duplicated version in version.txt and open api file.

Read the version from the apenapi3 YAML file. At the moment the version needs to be copied and pasted from the descriptor to the script.

Rebranding

• Rebranding branch created
• New design applied (font, logos, colors)
• Codename references renamed
• Ticker references renamed
• Links reviewed
• README reviewed
• Dependencies reviewed
• PR created
• Package renamed
• Package deployed

Automatize how openapi3-any-of-patch.yml is created.

At the moment, the file openapi3-any-of-patch.yml (that customizes the any of issues and the number-string types) is manually updated from the original openapi3.yml. We should create an automatic process that finds a replaces the patched areas.

Add copy to generated file to a local build folder before publish

• Would be better to output generated files into build folder before publish for reviewing purposes
• Add shell command for building.

Rename to nem2-openapi-generator and move to nemtech

NF wants to officialize this repository by moving it to nemtech. While doing that, we can fix the naming to nem2-openapi-generator.

A nemtech admin would need to accept the new ownership and it would need to make us (@rg911 and @fboucquez ) admin of the new repo so we can maintain it.

New repo would be
https://github.com/nemtech/nem2-openapi-generator

Typescript generator should support ES6

[Py] Add support for Python

Add support to generate Python package and distribution archive.

"java" vs "javascript" wording issue

https://github.com/NEMStudios/nem2-open-api-generator/blob/4a93f8af17c3242c424eec77e7882b2959aa36a8/generate.sh#L8

[Py] Add CI for the generated python package

Update the necessary scripts and/or templates to build, test, publish/release the symbol-openapi-python package to PyPi.

Missing "getTransactionsById" for partial and unconfirmed.

At the moment, only confirmed transactions can be loaded by multiple ids.

https://github.com/nemtech/symbol-openapi/blob/master/spec/routes.yml#L67

Is it possible to use path (state/group) params in the getById methods? I don't think they are going to change.