Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To create an API version (pre-)release, the API (pre-)release assets need to be created with naming rules as indicated in the below table.

API
state
versionAPI version (OAS file)API version extension (OAS file)API version in URL (OAS file)GitHub tag

GitHub release

package

package (name = tag)

GitHub release package tag
initial (x=0)0.y.z
)

 none

0.y.z

-alpha.m

-rc.n

v0.y.z (exception)

v0alpham

v0rcn

apiname-0.y.z

[

apiname-0.y.z-alpha.m

apiname-0.y.z

] (optional)

-rc.n

optional

optional [ pre-release ]
(optional)
alphax.y.z-alpha.mvxalphamapiname-x.y.z-alpha.m
[apiname-x.y.z-alpha.m ] (

optional

)

optional [ pre-release ]
(optional)
 
release-candidate x.y.z-rc.nvxrcnapiname-x.y.z-rc.n
apiname-x.y.z-rc.n
mandatorypre-release
public-releasex.y.znonevxapiname-x.y.z
apiname-x.y.z
mandatorylatest
work-in-progresswipN/AvwipN/AN/AN/A

This is illustrated in the following figure:

...