Skip to content

Commit 437af08

Browse files
authored
docs: add OpenAPI tag metadata for service documentation (#91)
1 parent 4c09ad2 commit 437af08

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

v2/api/archive-query-service/v2/query_services.proto

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@ option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
2323
description: "Github";
2424
url: "https://github.com/qubic/archive-query-service";
2525
}
26+
tags: {
27+
name: "ArchiveQueryService"
28+
description: "Access historical Qubic blockchain data including transactions, ticks, and computor lists."
29+
external_docs: {
30+
description: "GitHub repository"
31+
url: "https://github.com/qubic/archive-query-service/"
32+
}
33+
extensions: {
34+
key: "x-displayName"
35+
value: { string_value: "Query API" }
36+
}
37+
}
2638
};
2739

2840
// Qubic Query API

v2/api/archive-query-service/v2/query_services.swagger.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,13 @@
77
},
88
"tags": [
99
{
10-
"name": "ArchiveQueryService"
10+
"name": "ArchiveQueryService",
11+
"description": "Access historical Qubic blockchain data including transactions, ticks, and computor lists.",
12+
"externalDocs": {
13+
"description": "GitHub repository",
14+
"url": "https://github.com/qubic/archive-query-service/"
15+
},
16+
"x-displayName": "Query API"
1117
}
1218
],
1319
"host": "rpc.qubic.org",

0 commit comments

Comments
 (0)