Use the attribute `version` of the specification to register an artifact by UI

[rmarting]

Many API specifications includes a version property (e.g. OpenAPI, AsyncAPI). That property helps to identify the API version to others and it helps to identify changes between versions.

AsyncAPI Sample:

asyncapi: 2.1.0
info:
  title: Hello world application
  version: '0.1.0'

OpenApi Sample

openapi: 3.0.2
info:
    title: Hello World API
    version: 1.0.0

It could be a great feature to use that property from the API spec to define the version of the artifact when it is uploaded using the UI, as similar with the auto-detect feature, then use auto-version-detect check. That feature in the UI will allow the developer to use or not the same version declared in the API definition or, set up the version needed/required.

WDYT?

[EricWittmann]

I think this makes sense, overall. Good idea. There are some details to work out when updating (creating a new version) of an artifact. We can take the version from the content in that case too, but it's unclear what should happen if the content changed but the version # did not.

There are probably some other corner cases that we would need to think about...

[rmarting]

IMHO, if the content of an API definition changes but the not version # represents a bad practice in the API management. If you do that then third-party will not follow up in a right way.

The only scenario that it could be aligned with that practice is when you are publishing for the first time your API schema but it is something in developing and not published to others. It could make sense if you have a flag to identify that it is not a final version to be published and it might be changes in the content. But as soon you marked as a final version, you will not be able to change the content, only to upload a new version.

Does it make sense?

[EricWittmann]

This makes sense, yes. Esp. for registry (which in my view is a place to register only those artifacts that represent what has been deployed) I think we could just fail in my scenario above. Patch releases can be used for iterative development (e.g. when using the registry in a DEV environment).