Version from Swagger.json

[brandonSA]

Description

Is it possible to use the API version in the Swagger.json to update the version in the package.json file for publishing?

[mrlubos]

Hi @brandonSA, I'm not following the request. This package doesn't touch the package.json file. Can you explain what's needed in other words please?

[brandonSA]

@mrlubos, Sorry for being AWOL, been swamped at work, my use-case is to build a distributable Angular package using the code generated from the HeyAPI package and I wanted to used the version that I get from the Swagger.json to bump the package.json version before publishing.

[mrlubos]

@brandonSA do you have an existing script you can share? How do you imagine this package interacting with your package.json?

[Patrick-Wilkes]

Hitchhiking off this post, it might be valuable to make some of the data that is exposed in openapi.json files in the info section. I am using a custom plugin for this that exposes the info to a metadata.gen.ts file. It's pretty rough right now, but the most relevant part would be:

import type { Plugin } from '@hey-api/openapi-ts';
import type { Config } from './types';

export const handler: Plugin.Handler<Config> = ({ context, plugin }) => {
  const file = context.createFile({
    id: plugin.name,
    path: plugin.output,
  });

  // Create const for every set info value
  const { info } = context.spec;
  Object.entries(info).forEach(([key, value]) => {
    const stringLiteral = ts.factory.createStringLiteral(value);
    const variableDeclaration = ts.factory.createVariableDeclaration(key, undefined, undefined, stringLiteral);
    const node = ts.factory.createVariableStatement(
      [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
      ts.factory.createVariableDeclarationList([variableDeclaration], ts.NodeFlags.Const),
    );
    // add node to file
    file.add(node);
  });
};

I mainly use it to be able to easily tell the API version the client was generated against. Let me know if this is of future interest

[mrlubos]

@Patrick-Wilkes want to feature it under community plugins?

[Patrick-Wilkes]

For sure! I'll see that I prepare a pull request for it

[mrlubos]

If you want, you could publish it as your own plugin package. If you want it to be a part of the repo, that also works. I'd list you as a collaborator, but I'd need some help with writing docs as I'm not sure how you're using it and the problems it solves. It doesn't feel like it quite addresses the original issue without additional setup. It's also a bit more tricky with maintenance when someone else wrote the plugin if it's hosted under this repo, I haven't figured out that part yet!

[Patrick-Wilkes]

To be honest, the only problem it solves is listing the version of the openapi.json. This potentially helps us with our deployments as we can avoid having a client that has been generated against an "old" openapi.json. I say potentially because we have not actually used it yet in our project. The easy use case would be displaying the version somewhere, it might be useful to have a test that fails if the version numbers don't match.

If this is useful enough to make sense in the repo, I'd be glad to help out

[mrlubos]

I'd say try it in a live project first, we can polish and merge it after that.

As for the API drift problem, that's one of the reasons the platform exists! I have some thoughts around solving that but haven't gotten around to polishing it yet either.