diff --git a/README.md b/README.md index 33ee122..143abad 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ # Schema -TypeSpec schema for BlueBuild. \ No newline at end of file +TypeSpec schema for BlueBuild. + +## Versioning + +The recipe model uses a crude versioning scheme:_ +- The baseUri and filename of the recipe schema is `recipe-vX.json` +- `X` is be the number of the version of the recipe format the model represents, starting at `1`. + - When a breaking change is made, the number shall be incremented by one. The old version should also be kept, with the previous version number, and in a separate file and model. + - This number may be used to select which version of the standard to process in [blue-build/cli](https://github.com/blue-build/cli/) \ No newline at end of file diff --git a/src-tsp/main.tsp b/src-tsp/main.tsp index ea2a7fb..30cf0a0 100644 --- a/src-tsp/main.tsp +++ b/src-tsp/main.tsp @@ -3,8 +3,8 @@ import "./modules.tsp"; using TypeSpec.JsonSchema; -@jsonSchema("recipe.json") -model recipe { +@jsonSchema("recipe-v1.json") +model Recipe { name: string, description: string, "base-image": string,