...
we need to search over data across multiple anchors for a given dataspace. for this requirement below changes are proposed
Issues & Decisions
| # | Issue | Notes | Decision |
|---|---|---|---|
| 1 | Exact |
| response format | would like to be able to determine which |
data is from which anchor See |
2 alternatives below | |||
| 2 | include-descendants | should we use 'include-descendants' (true | false) in query parameter as we have in V1 or do we need to use 'descendants' in query parameter as in V2 |
|---|
Endpoint Definition
New endpoint : GET http://localhost:8883/cps/api/v2/dataspaces/{dataspace-name}/nodes/query
...
| # | scenario | Body Structures | Response Body Example | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | withoutanchor name | [{data-tree1},..,{data-tree-n}] |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"test:bookstore": {
"bookstore-name": "Chapters",
"categories": [
{
"code": 1,
"name": "SciFi"
},
{
"code": 2,
"name": "kids"
}
]
}
},
{
"test:bookstore2": {
"bookstore-name": "Chapters2",
"categories": [
{
"code": 10,
"name": "SciFi"
},
{
"code": 20,
"name": "kids"
}
]
}
}
] |
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"test:bookstore": {
"bookstore-name": "Chapters",
"categories": [
{
"code": 1,
"name": "SciFi"
},
{
"code": 2,
"name": "kids"
}
]
},
"anchorName": "anchor01"
},
{
"test:bookstore2": {
"bookstore-name": "Chapters2",
"categories": [
{
"code": 10,
"name": "SciFi"
},
{
"code": 20,
"name": "kids"
}
]
},
"anchorName": "anchor02"
}
] |
[
{"anchorName":"anchor-01",
"dataNodes":[{data-tree1},...
{data-tree-n}]
...
,{"anchorName":"anchor-02",
"dataNodes": [{datatree1},...,{data-tree-n}]
}
]
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
[
{
"anchorName":"anchor01",
"dataNodes":[
{
"test:bookstore":{
"bookstore-name":"Chapters",
"categories":[
{
"code":1,
"name":"SciFi"
}
]
}
}
]
},
{
"anchorName":"anchor02",
"dataNodes":[
{
"test:bookstore":{
"bookstore-name":"store01",
"categories":[
{
"code":2,
"name":"SciFi"
}
]
}
}
]
}
] |
...