The future of this package

[simenandre]

Hello 👋

I have a few packages that utilize OpenAPI Generator in order to automatically generate SDKs for services such as Tripletex, Uni Economy etc. This package however, does not hold today's standard – and it's not utilized enough that I want to keep maintaining it as is. It needs a refactor, and I think the best option is to refactor it to use OpenAPI Generator with Typescript.

An example can be seen here, bjerkio/crayon-api-js. However, since this has been neglected for far too long, I'll give this some time to make sure it has everything to succeed when we release it.

Do you use Visma eAccounting? Are you developing your very own software that needs this package to be better? Please reach out! I'll love to get help / co-maintain, etc.

[simenandre]

The swagger file is available here:
https://eaccountingapi-sandbox.test.vismaonline.com/swagger/ui/index

Are they valid?

Update (20. February 2022): Swagger validator images are failing, so I'm updating this manually.

• Visma eAccounting (v1 API) is invalid.
  This is according to swagger.io validator

• Visma eAccounting (v2 API) is invalid
  This is according to swagger.io validator

[simenandre]

Some thoughts on implementation.

If there is a change in our Swagger file, a tool analyzes old and new swagger file. This tool checks if it is a mayor (breaking change), minor (adds feature)
or patch (bugfix, refactor etc.). This tool determines what part of our version to bump (X.X.X), so that we can keep our own version for the library.

This is required because our friends over at Visma eAccounting only reports major
version for their API, therefore we cannot utilize their version for upkeep.

We also want to support both versions of the API. Maybe we should have our major version follow theirs? So, for API v1 we use 1.x.x and for API v2 we use 2.x.x. If they release a new version, we release a new version. That could work, only problem with that is if Visma eAccounting makes a change to their API that is breaking changes. We don't know if Visma eAccounting actually are following the specifications of Semantic Versioning. To make sure, we have to analyze their work always.

Anyway, I need a tool to analyze swagger files to determine what version to release, so that is next on the agenda.

[simenandre]

There has been progress on this. next branch now has a working implementation on v1. However, there are a lot of duplicate operationIds on v2.

More on that here: https://github.com/cobraz/eaccounting/blob/next/TODO.md

[simenandre]

Work has started on this #9

[tgangso]

Dead?

[simenandre]

We haven't done a lot on it for some time, no. It isn't dead; we're using some of it in production, but it hasn't been updated much for quite some time.

Are you working on a project where you are thinking of using this? In that case, I would love to team up to make some progress!