search

LiveRamp / reslang

A language for describing resource-oriented APIs & turning them into Swagger or resource diagrams. Oriented around the concepts we want to expose in the APIs.
Apache License 2.0
23 stars 7 forks source link

Generated code should be tagged with source commit hash #19

Closed pratikmallya closed 4 years ago

pratikmallya commented 4 years ago

Currently, looking at the swagger generated by reslang, its ambiguous as to what version of the tool was used. This makes it hard for independent verification as its impossible to know what version of reslang was used to generate the documentation.

Suggestion: automatically add the reslang git commit as a reslang-git-commit field to indicate unabiguosly what version of reslang was used in the info section of the swagger. e.g.

openapi: 3.0.1
info:
  title: 'Cool New Api'
  description: Cool New Api
  version: 0.1.0
  reslang-git-commit: e9dbce4f6628e4725bc3973f466e58a6a7f51fd1

Alternatively, adopt versioning for releases and use version number to indicate what version of reslang was used to generate

liveandrew commented 4 years ago

added a reslang version comment at the start of each yaml file. currently at 0.9.0, will bring up to v1.0.0 by end of week hopefully. please reopen if this is not sufficient

https://github.com/LiveRamp/reslang/commit/386ed6538e289bfb57f2f9cdf30bb92af5439122