BrAPI icon indicating copy to clipboard operation
BrAPI copied to clipboard

Systematic documentation of BrAPI endpoint versioning

Open RichardBruskiewich opened this issue 5 years ago • 1 comments

It may be helpful that the endpoints themselves be systematically tagged in their Markdown documentation with respect to the specific version of the BrAPI specification within which they were introduced. Maybe deprecation decisions could be similarly indicated (e.g. when deprecated endpoints will be removed)?

Alternately, the root README markdown file one each major subfolder could have a single summary table / listing of endpoints with their origin version of introduction and deprecation (if applicable) at the top of each major BrAPI component set. One additional step would be to have the table entries point to the specific Markdown and/or YAML spec (section) which describes the endpoint (this latter web page could be the Apiary or Swagger doc version).

RichardBruskiewich avatar May 01 '19 14:05 RichardBruskiewich

I would love to see this. The information has also already been compiled in the excel files floating around.

dauglyon avatar May 03 '19 13:05 dauglyon