Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Commit

Permalink
Add descriptions to new bursar export shemas
Browse files Browse the repository at this point in the history
  • Loading branch information
@nhanaa
nhanaa committed Sep 15, 2023
1 parent a586c84 commit fc519f3
Show file tree
Hide file tree
Showing 24 changed files with 82 additions and 4 deletions.
7 changes: 7 additions & 0 deletions schemas/bursar-export/bursarExportJob.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,40 @@
"type": "object",
"properties": {
"filter": {
"description": "Filter to use for the regular export",
"$ref": "filter/bursarExportFilter.json"
},
"groupByPatron": {
"description": "Choose whether to group fee/fines by patron",
"type": "boolean"
},
"groupByPatronFilter": {
"description": "Filter to use for the export when grouping by patron",
"$ref": "filter/bursarExportFilterAggregate.json"
},
"header": {
"description": "Header format for the export file",
"type": "array",
"items": {
"$ref": "tokens/bursarExportHeaderFooter.json"
}
},
"data": {
"description": "Data format for the export file",
"type": "array",
"items": {
"$ref": "tokens/bursarExportDataToken.json"
}
},
"footer": {
"description": "Footer format for the export file",
"type": "array",
"items": {
"$ref": "tokens/bursarExportHeaderFooter.json"
}
},
"transferInfo": {
"description": "Transfer information for the export",
"$ref": "transfer/bursarExportTransferCriteria.json"
}
},
Expand Down
5 changes: 4 additions & 1 deletion schemas/bursar-export/filter/bursarExportFilterAge.json
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
{
"description": "Filter by fees older than certain number of days",
"description": "Filter by fees within certain days range",
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Age"
},
"numDays": {
"description": "Number of days",
"type": "integer",
"minimum": 1
},
"condition": {
"description": "Condition to get days range",
"type": "string",
"enum": [
"LESS_THAN_EQUAL",
Expand Down
4 changes: 4 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterAggregate.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,21 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Aggregate"
},
"property": {
"description": "Property to filter on",
"type": "string",
"enum": ["NUM_ROWS", "TOTAL_AMOUNT"]
},
"amount": {
"description": "Amount to filter on",
"type": "integer"
},
"condition": {
"description": "Condition to filter on",
"type": "string",
"enum": [
"LESS_THAN_EQUAL",
Expand Down
3 changes: 3 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterAmount.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Amount"
},
"amount": {
"description": "Amount to filter by",
"type": "integer"
},
"condition": {
"description": "Condition to filter by",
"type": "string",
"enum": [
"LESS_THAN_EQUAL",
Expand Down
3 changes: 3 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterCondition.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Condition"
},
"operation": {
"description": "Conditional operation of the filter",
"type": "string",
"enum": ["AND", "OR"]
},
"criteria": {
"description": "Criteria to apply of the filter",
"type": "array",
"items": {
"$ref": "bursarExportFilter.json"
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterFeeFineOwner.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "FeeFineOwner"
},
"feeFineOwner": {
"description": "Id of fee/fine owner to filter by",
"type": "string",
"format": "uuid"
}
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterFeeType.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "FeeType"
},
"feeFineTypeId": {
"description": "Id of fee/fine type to filter by",
"type": "string",
"format": "uuid"
}
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterLocation.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Location"
},
"locationId": {
"description": "Id of location to filter by",
"type": "string",
"format": "uuid"
}
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterNegation.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Negation"
},
"criteria": {
"description": "Filter to negate",
"$ref": "bursarExportFilter.json"
}
},
Expand Down
1 change: 1 addition & 0 deletions schemas/bursar-export/filter/bursarExportFilterPass.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "Pass"
}
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterPatronGroup.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "PatronGroup"
},
"patronGroupId": {
"description": "Id of patron group to filter by",
"type": "string",
"format": "uuid"
}
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/filter/bursarExportFilterServicePoint.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of filter",
"type": "string",
"default": "ServicePoint"
},
"servicePointId": {
"description": "Id of service point to filter by",
"type": "string",
"format": "uuid"
}
Expand Down
5 changes: 4 additions & 1 deletion schemas/bursar-export/tokens/bursarExportTokenAggregate.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,21 @@
"type": "object",
"properties": {
"type": {
"description": "Type of data token",
"type": "string",
"default": "Aggregate"
},
"value": {
"description": "Data to represent",
"type": "string",
"enum": ["NUM_ROWS", "TOTAL_AMOUNT"]
},
"decimal": {
"type": "boolean",
"description": "only applicable for total amount"
"description": "Whether to return value with decimal. Only applicable for total amount"
},
"lengthControl": {
"description": "Control length of the token",
"$ref": "bursarExportTokenLengthControl.json"
}
},
Expand Down
5 changes: 5 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenConditional.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,22 @@
"type": "object",
"properties": {
"type": {
"description": "Type of the data token",
"type": "string",
"default": "Conditional"
},
"conditions": {
"description": "Conditions to apply to the token",
"type": "array",
"items": {
"type": "object",
"properties": {
"condition": {
"description": "Condition to apply to the item",
"$ref": "../filter/bursarExportFilter.json"
},
"value": {
"description": "Data to represent if the condition is true",
"$ref": "bursarExportDataToken.json"
}
},
Expand All @@ -23,6 +27,7 @@
}
},
"else": {
"description": "Data to represent if no condition is true",
"$ref": "bursarExportDataToken.json"
}
},
Expand Down
2 changes: 2 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenConstant.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of data token",
"type": "string",
"default": "Constant"
},
"value": {
"description": "Value of the constant",
"type": "string"
}
},
Expand Down
4 changes: 4 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenCurrentDate.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,20 @@
"type": "object",
"properties": {
"type": {
"description": "Type of data token",
"type": "string",
"default": "Date"
},
"value": {
"description": "Type of date value to represent",
"$ref": "bursarExportTokenDateType.json"
},
"timezone": {
"description": "Timezone to use for date",
"type": "string"
},
"lengthControl": {
"description": "Control length of the token",
"$ref": "bursarExportTokenLengthControl.json"
}
},
Expand Down
3 changes: 3 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenFeeAmount.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@
"type": "object",
"properties": {
"type": {
"description": "Type of data token",
"type": "string",
"default": "FeeAmount"
},
"decimal": {
"description": "Whether to return value with decimal",
"type": "boolean"
},
"lengthControl": {
"description": "Control length of the token",
"$ref": "bursarExportTokenLengthControl.json"
}
},
Expand Down
6 changes: 6 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenFeeDate.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,29 @@
"type": "object",
"properties": {
"type": {
"description": "Type of data token",
"type": "string",
"default": "FeeDate"
},
"property": {
"description": "Property of fee to be represented by token",
"type": "string",
"enum": ["CREATED", "UPDATED", "DUE", "RETURNED"]
},
"value": {
"description": "Type of date value to represent",
"$ref": "bursarExportTokenDateType.json"
},
"placeholder": {
"description": "Placeholder value to use if date is not available",
"type": "string"
},
"timezone": {
"description": "Timezone to use for date",
"type": "string"
},
"lengthControl": {
"description": "Control length of token",
"$ref": "bursarExportTokenLengthControl.json"
}
},
Expand Down
3 changes: 3 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenFeeMetadata.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
"type": "object",
"properties": {
"type": {
"description": "Type of data token",
"type": "string",
"default": "FeeMetadata"
},
"value": {
"description": "Metadata to represent",
"type": "string",
"enum": ["FEE_FINE_TYPE_ID", "FEE_FINE_TYPE_NAME"]
},
"lengthControl": {
"description": "Control length of token",
"$ref": "bursarExportTokenLengthControl.json"
}
},
Expand Down
4 changes: 4 additions & 0 deletions schemas/bursar-export/tokens/bursarExportTokenItemData.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
"type": "object",
"properties": {
"type": {
"description": "Type of token",
"type": "string",
"default": "ItemData"
},
"value": {
"description": "Item data to represent",
"type": "string",
"enum": [
"BARCODE",
Expand All @@ -19,9 +21,11 @@
]
},
"placeholder": {
"description": "Placeholder text to display when no value is available",
"type": "string"
},
"lengthControl": {
"description": "Control length of token",
"$ref": "bursarExportTokenLengthControl.json"
}
},
Expand Down
Loading

0 comments on commit fc519f3

Please sign in to comment.