The process of reflecting new Messaging API features in SDKs

Hello! I'm Zenigami, a technical writer. Are you using the Messaging API SDKs provided by LY Corporation?

Previously, SDK updates corresponding to new Messaging API features were done manually. By switching to automatic generation using OpenAPI Generator, you can now access new features through the SDKs much faster.

In this article, I will introduce the process from when a new feature is added to the Messaging API until SDKs for various languages like Java and Python are updated.

• Target SDKs
• Process of reflecting new features
  • 1. LINE OpenAPI specifications are updated
  • 2. SDKs and pull requests are auto-generated
  • 3. SDKs are released
• Conclusion

Target SDKs

The Messaging API provides SDKs for the following languages. The process introduced in this article applies to all of them.

• Java
• Python
• Node.js
• Go
• PHP
• Ruby

Process of reflecting new features

Now, let me explain the process from when a new feature is added to the Messaging API until it is reflected in the SDKs. To ensure that new features are available through the SDKs as quickly as possible, we update the SDKs through the following process:

1. LINE OpenAPI specifications are updated
2. SDKs and pull requests are auto-generated
3. SDKs are released

I will explain each step in the process.

1. LINE OpenAPI specifications are updated

When new features are added to the Messaging API, the LINE OpenAPI on GitHub will be updated accordingly. In this repository, the Messaging API specifications are defined in a format compliant with the OpenAPI specification.

2. SDKs and pull requests are auto-generated

When the LINE OpenAPI specification is updated, OpenAPI Generator is run on each SDK repository to automatically generate the source code. Pull requests are also automatically created for each repository.

For example, in the pull request to add a feature for marking messages as read in LINE OpenAPI, references from the automatically created pull requests are posted as shown below.

3. SDKs are released

The automatically generated pull requests are reviewed by maintainers and then merged. Once the pull requests are merged, the new versions of the SDKs will be published to package registries for each language, such as Maven Central and PyPI.

The LINE Developers site does not send out notifications when SDKs are updated. For this reason, we recommend that you Watch the repository of the SDK you are using.

Conclusion

Once new versions of the SDKs are released as described above, developers can start using the new Messaging API features through the SDKs. I hope you enjoy developing even more by using the SDKs!