CPS-2189 - Support for Async datajobs Read
- Kolawole Adebisi-Adeolokun
- Sourabh Sourabh
References
CPS-2172: OpenTelemetry tracingClosed
Assumptions
Assumption | Notes | Sign-off | |
|---|---|---|---|
| 1 | |||
| 2 |
Issues & Decisions
Issue | Notes | Decision | |
|---|---|---|---|
| 1 | |||
| 2 | |||
| 3 |
Data Structures
DataJob Read Request Structure
Element | Description |
|---|---|
DataJobReadRequest | Container for the read request |
ReadOperations | Contains one or more ReadItems |
ReadItem | A specific read operation |
op | Operation type |
operationId | Unique identifier for the operation |
path | Path for the resource |
scope | Scope of the request |
filter | Filter to apply to the request |
attributes | Attributes to be returned |
fields | Fields to be returned |
URI Query Parameters Supported by the GET Method
Name | Data Type | Description | S |
|---|---|---|---|
scope | Scope | Extends the set of targeted resources beyond the base resource identified with the URI | O |
filter | Filter | Reduces the targeted set of resources by applying a filter | O |
attributes | array(string) | Attributes of the scoped resources to be returned. Value is a comma-separated list of names | O |
fields | array(string) | Attribute fields of the scoped resources to be returned. Value is a list of JSON pointers | O |
Requirements
Requirement | Additional Information | Signoff | |
|---|---|---|---|
| 1 | |||
| 2 | |||
| 3 |
Characteristics
Parameter | Expectation | Notes | Signoff | |
|---|---|---|---|---|
| 1 |
Error Handling
Parameter | Expectation | Notes | Signoff | |
|---|---|---|---|---|
| 1 |