Skip to content

Commit

Permalink
Add description in README for file
Browse files Browse the repository at this point in the history
Signed-off-by: He Xiaoxi <[email protected]>
  • Loading branch information
tossmilestone committed Aug 15, 2017
1 parent 1540992 commit b891ae7
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,19 @@ $ make generate
```

Click [here](https://github.com/google/protobuf) for more information about protobuf.

The `api.pb.txt` file contains merged descriptors of all defined services and messages.
Definitions present here are considered frozen after the release.

At release time, the current `api.pb.txt` file will be moved into place to
freeze the API changes for the minor version. For example, when 1.0.0 is
released, `api.pb.txt` should be moved to `1.0.txt`. Notice that we leave off
the patch number, since the API will be completely locked down for a given
patch series.

We may find that by default, protobuf descriptors are too noisy to lock down
API changes. In that case, we may filter out certain fields in the descriptors,
possibly regenerating for old versions.

This process is similar to the [process used to ensure backwards compatibility
in Go](https://github.com/golang/go/tree/master/api).

0 comments on commit b891ae7

Please sign in to comment.