Version Change Specification

apihug/protobuf/extend/version.proto still exists in the current source, but the file is marked deprecated. New projects should prefer milestone and changelog documentation for human release notes, but older proto contracts may still carry these annotations.

• Extension Package: apihug/protobuf/extend/version.proto
• Scope: File / Service / Method / Message / Enum / Field
• Status: Deprecated compatibility layer

1. Import and Registration

import "apihug/protobuf/extend/version.proto";

Registered extension points:

31142 is reused for file and method descriptors, and 31143 is reused for message, service, enum, and field descriptors. That is valid because each registration targets a different protobuf descriptor type.

2. VersionTypeEnum

enum VersionTypeEnum {
  NA = 0;
  ADD = 1;
  MODIFY = 2;
  REMOVE = 3;
}

3. Version Message

message Version {
  string version = 1;
  string timestamp = 2;
  VersionTypeEnum type = 10;
  string message = 11;
  string track = 12;
  string updated_by = 20;
}

4. Example

import "apihug/protobuf/extend/version.proto";

service UserApi {
  option (hope.version.svc) = [{
    version: "2.0.0-RELEASE";
    timestamp: "2025-05-15";
    type: MODIFY;
    message: "Merged legacy proto/app split into unified app module";
    track: "MILESTONE-2.0.0";
    updated_by: "Aaron";
  }];
}

5. Practical Guidance

• Keep reading these annotations when auditing old proto files.
• Do not introduce new hope.version.* usage unless you are maintaining backward compatibility with an existing contract.
• Prefer Milestone and Changelog pages for current release history.