Skip to content

Commit d50e275

Browse files
qubicmioqubicmio
committed
Update documentation with should filter terms/ranges
1 parent dbaba48 commit d50e275

File tree

3 files changed

+53
-19
lines changed

3 files changed

+53
-19
lines changed

‎v2/api/archive-query-service/v2/query_services.openapi.yaml‎

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -63,24 +63,31 @@ paths:
6363
\ | source | string | 60 character identity, up to 5, comma separated.\
6464
\ | Only find logs with another source. |\n | destination | string | 60 character\
6565
\ identity, up to 5, comma separated. | Only find logs with another destination.\
66-
\ |\n\n #### Should filter properties\n\n | Name | Type |\
67-
\ Format | Description |\n |-----------------|---------|----------|---------------------------------------------------------|\n\
66+
\ |\n\n #### Should filter term properties\n\n | Name | Type\
67+
\ | Format | Description |\n\
68+
\ |-----------------|---------|----------|---------------------------------------------------------|\n\
6869
\ | source | string | 60 character identity, up to 5, comma separated.\
6970
\ | Find logs with this source. |\n | destination | string | 60 character\
70-
\ identity, up to 5, comma separated. | Find logs with this source. |\n\n\
71-
\ #### Range filter properties\n\n Ranges restrict the results to a range\
72-
\ of values by defining a maximum and/or minimum value.\n\n | Name |\
73-
\ Type | Format | Description \
74-
\ |\n |------------|--------|------------------------------------------|---------------------------------------------|\n\
71+
\ identity, up to 5, comma separated. | Find logs with this source. |\n\
72+
\ | amount | string | Numeric | Find logs with this amount. |\n | numberOfShares\
73+
\ | string | Numeric | Find logs with these number of shares. |\n\n ####\
74+
\ Should filter range properties\n\n | Name | Type | Format\
75+
\ | Description |\n |-----------------|---------|----------|---------------------------------------------------------|\n\
76+
\ | amount | string | Numeric | Find logs in the amount range. |\n |\
77+
\ numberOfShares | string | Numeric | Find logs in the number of shares range.\
78+
\ |\n\n #### Range filter properties\n\n Ranges restrict the results to a\
79+
\ range of values by defining a maximum and/or minimum value.\n\n | Name \
80+
\ | Type | Format | Description \
81+
\ |\n |------------|--------|------------------------------------------|---------------------------------------------|\n\
7582
\ | amount | string | Numeric | Only\
7683
\ find logs in the amount range. |\n | numberOfShares | string | Numeric\
7784
\ | Only find logs withing the number of shares\
78-
\ range (assets). |\n | tickNumber | string | Numeric \
79-
\ | Only find logs in the tick range. |\n | timestamp \
80-
\ | string | Numeric (Unix Timestamp in milliseconds) | Only find logs in\
81-
\ the time range. |\n\n ### Pagination\n\n | Name | Type | Necessity\
82-
\ | Description \
83-
\ |\n |--------|--------|-----------|-----------------------------------------------------------------------------------------------------|\n\
85+
\ range. |\n | tickNumber | string | Numeric \
86+
\ | Only find logs in the tick range. |\n | timestamp | string\
87+
\ | Numeric (Unix Timestamp in milliseconds) | Only find logs in the time\
88+
\ range. |\n\n ### Pagination\n\n | Name | Type | Necessity | Description\
89+
\ \
90+
\ |\n |--------|--------|-----------|-----------------------------------------------------------------------------------------------------|\n\
8491
\ | offset | uint32 | optional | The offset of the first record to return.\
8592
\ Defaults to zero (first record). Maximum offset is 10000. |\n | size |\
8693
\ uint32 | optional | Defaults to 10. Maximum size is 1000. Zero value is\

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,12 +287,21 @@ service ArchiveQueryService {
287287
// | source | string | 60 character identity, up to 5, comma separated. | Only find logs with another source. |
288288
// | destination | string | 60 character identity, up to 5, comma separated. | Only find logs with another destination. |
289289
//
290-
// #### Should filter properties
290+
// #### Should filter term properties
291291
//
292292
// | Name | Type | Format | Description |
293293
// |-----------------|---------|----------|---------------------------------------------------------|
294294
// | source | string | 60 character identity, up to 5, comma separated. | Find logs with this source. |
295295
// | destination | string | 60 character identity, up to 5, comma separated. | Find logs with this source. |
296+
// | amount | string | Numeric | Find logs with this amount. |
297+
// | numberOfShares | string | Numeric | Find logs with these number of shares. |
298+
//
299+
// #### Should filter range properties
300+
//
301+
// | Name | Type | Format | Description |
302+
// |-----------------|---------|----------|---------------------------------------------------------|
303+
// | amount | string | Numeric | Find logs in the amount range. |
304+
// | numberOfShares | string | Numeric | Find logs in the number of shares range. |
296305
//
297306
// #### Range filter properties
298307
//
@@ -301,7 +310,7 @@ service ArchiveQueryService {
301310
// | Name | Type | Format | Description |
302311
// |------------|--------|------------------------------------------|---------------------------------------------|
303312
// | amount | string | Numeric | Only find logs in the amount range. |
304-
// | numberOfShares | string | Numeric | Only find logs withing the number of shares range (assets). |
313+
// | numberOfShares | string | Numeric | Only find logs withing the number of shares range. |
305314
// | tickNumber | string | Numeric | Only find logs in the tick range. |
306315
// | timestamp | string | Numeric (Unix Timestamp in milliseconds) | Only find logs in the time range. |
307316
//

‎v2/api/archive-query-service/v2/query_services_grpc.pb.go‎

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

0 commit comments

Comments
 (0)