Skip to content

Commit 5886c2c

Browse files
Change endpoint paths and add documentation
1 parent 671bc67 commit 5886c2c

File tree

6 files changed

+104
-88
lines changed

6 files changed

+104
-88
lines changed

protobuff/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ all: $(GO) openapi
2929

3030
openapi: *.proto
3131
protoc --openapiv2_out=logtostderr=true:. \
32-
--proto_path=.:/opt/homebrew/Cellar/protobuf/25.3_1/include \
3332
*.proto
33+
# --proto_path=.:/opt/homebrew/Cellar/protobuf/25.3_1/include \
3434
3535
clean:
3636
rm -f *.pb.go

protobuff/qubic.pb.go

Lines changed: 34 additions & 37 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

protobuff/qubic.pb.gw.go

Lines changed: 12 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

protobuff/qubic.proto

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -269,27 +269,31 @@ service QubicLiveService {
269269
};
270270
};
271271

272+
// Returns an issued asset.
272273
rpc GetIssuedAssetByUniverseIndex(GetIssuedAssetByUniverseIndexRequest) returns (AssetIssuance) {
273274
option (google.api.http) = {
274-
get: "/assets/by-universe-index/{index}"
275+
get: "/assets/issuers/{index}"
275276
};
276277
}
277278

279+
// Returns a list of issued assets.
278280
rpc GetIssuedAssetsByFilter(GetIssuedAssetsByFilterRequest) returns (AssetIssuances) {
279281
option (google.api.http) = {
280-
get: "/assets/by-filter/issued"
282+
get: "/assets/issuers"
281283
};
282284
}
283285

286+
// Returns a list of asset owners. Asset name and issuer are required. Issuer defaults to zero address.
284287
rpc GetOwnedAssetsByFilter(GetOwnedAssetsByFilterRequest) returns (AssetOwnerships) {
285288
option (google.api.http) = {
286-
get: "/assets/by-filter/owned"
289+
get: "/assets/owners"
287290
};
288291
}
289292

293+
// Returns a list of asset possessors. Asset name and issuer are required. Issuer defaults to zero address.
290294
rpc GetPossessedAssetsByFilter(GetPossessedAssetsByFilterRequest) returns (AssetPossessions) {
291295
option (google.api.http) = {
292-
get: "/assets/by-filter/possessed"
296+
get: "/assets/possessors"
293297
};
294298
}
295299

0 commit comments

Comments
 (0)