From fc519f392a8c61184a8ca3dadb94c3cab1d6ae5c Mon Sep 17 00:00:00 2001 From: nhanaa Date: Fri, 15 Sep 2023 16:24:15 -0500 Subject: [PATCH] Add descriptions to new bursar export shemas --- schemas/bursar-export/bursarExportJob.json | 7 +++++++ schemas/bursar-export/filter/bursarExportFilterAge.json | 5 ++++- .../bursar-export/filter/bursarExportFilterAggregate.json | 4 ++++ schemas/bursar-export/filter/bursarExportFilterAmount.json | 3 +++ .../bursar-export/filter/bursarExportFilterCondition.json | 3 +++ .../filter/bursarExportFilterFeeFineOwner.json | 2 ++ .../bursar-export/filter/bursarExportFilterFeeType.json | 2 ++ .../bursar-export/filter/bursarExportFilterLocation.json | 2 ++ .../bursar-export/filter/bursarExportFilterNegation.json | 2 ++ schemas/bursar-export/filter/bursarExportFilterPass.json | 1 + .../filter/bursarExportFilterPatronGroup.json | 2 ++ .../filter/bursarExportFilterServicePoint.json | 2 ++ .../bursar-export/tokens/bursarExportTokenAggregate.json | 5 ++++- .../bursar-export/tokens/bursarExportTokenConditional.json | 5 +++++ .../bursar-export/tokens/bursarExportTokenConstant.json | 2 ++ .../bursar-export/tokens/bursarExportTokenCurrentDate.json | 4 ++++ .../bursar-export/tokens/bursarExportTokenFeeAmount.json | 3 +++ schemas/bursar-export/tokens/bursarExportTokenFeeDate.json | 6 ++++++ .../bursar-export/tokens/bursarExportTokenFeeMetadata.json | 3 +++ .../bursar-export/tokens/bursarExportTokenItemData.json | 4 ++++ .../tokens/bursarExportTokenLengthControl.json | 6 +++++- .../bursar-export/tokens/bursarExportTokenUserData.json | 3 +++ .../tokens/bursarExportTokenUserDataOptional.json | 4 ++++ .../transfer/bursarExportTransferCriteria.json | 6 +++++- 24 files changed, 82 insertions(+), 4 deletions(-) diff --git a/schemas/bursar-export/bursarExportJob.json b/schemas/bursar-export/bursarExportJob.json index 2b5ed4f..bc30166 100644 --- a/schemas/bursar-export/bursarExportJob.json +++ b/schemas/bursar-export/bursarExportJob.json @@ -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" } }, diff --git a/schemas/bursar-export/filter/bursarExportFilterAge.json b/schemas/bursar-export/filter/bursarExportFilterAge.json index 4646d3b..b9fd41d 100644 --- a/schemas/bursar-export/filter/bursarExportFilterAge.json +++ b/schemas/bursar-export/filter/bursarExportFilterAge.json @@ -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", diff --git a/schemas/bursar-export/filter/bursarExportFilterAggregate.json b/schemas/bursar-export/filter/bursarExportFilterAggregate.json index 1cd69ed..db1b167 100644 --- a/schemas/bursar-export/filter/bursarExportFilterAggregate.json +++ b/schemas/bursar-export/filter/bursarExportFilterAggregate.json @@ -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", diff --git a/schemas/bursar-export/filter/bursarExportFilterAmount.json b/schemas/bursar-export/filter/bursarExportFilterAmount.json index 162b209..2ca7804 100644 --- a/schemas/bursar-export/filter/bursarExportFilterAmount.json +++ b/schemas/bursar-export/filter/bursarExportFilterAmount.json @@ -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", diff --git a/schemas/bursar-export/filter/bursarExportFilterCondition.json b/schemas/bursar-export/filter/bursarExportFilterCondition.json index 2b21c9c..49b0ed6 100644 --- a/schemas/bursar-export/filter/bursarExportFilterCondition.json +++ b/schemas/bursar-export/filter/bursarExportFilterCondition.json @@ -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" diff --git a/schemas/bursar-export/filter/bursarExportFilterFeeFineOwner.json b/schemas/bursar-export/filter/bursarExportFilterFeeFineOwner.json index fadd8a1..5b93ef1 100644 --- a/schemas/bursar-export/filter/bursarExportFilterFeeFineOwner.json +++ b/schemas/bursar-export/filter/bursarExportFilterFeeFineOwner.json @@ -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" } diff --git a/schemas/bursar-export/filter/bursarExportFilterFeeType.json b/schemas/bursar-export/filter/bursarExportFilterFeeType.json index 516e883..b058b9e 100644 --- a/schemas/bursar-export/filter/bursarExportFilterFeeType.json +++ b/schemas/bursar-export/filter/bursarExportFilterFeeType.json @@ -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" } diff --git a/schemas/bursar-export/filter/bursarExportFilterLocation.json b/schemas/bursar-export/filter/bursarExportFilterLocation.json index 266d520..6bb0de0 100644 --- a/schemas/bursar-export/filter/bursarExportFilterLocation.json +++ b/schemas/bursar-export/filter/bursarExportFilterLocation.json @@ -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" } diff --git a/schemas/bursar-export/filter/bursarExportFilterNegation.json b/schemas/bursar-export/filter/bursarExportFilterNegation.json index 4490e7b..d118751 100644 --- a/schemas/bursar-export/filter/bursarExportFilterNegation.json +++ b/schemas/bursar-export/filter/bursarExportFilterNegation.json @@ -3,10 +3,12 @@ "type": "object", "properties": { "type": { + "description": "Type of filter", "type": "string", "default": "Negation" }, "criteria": { + "description": "Filter to negate", "$ref": "bursarExportFilter.json" } }, diff --git a/schemas/bursar-export/filter/bursarExportFilterPass.json b/schemas/bursar-export/filter/bursarExportFilterPass.json index 9aa4d43..cac8bea 100644 --- a/schemas/bursar-export/filter/bursarExportFilterPass.json +++ b/schemas/bursar-export/filter/bursarExportFilterPass.json @@ -3,6 +3,7 @@ "type": "object", "properties": { "type": { + "description": "Type of filter", "type": "string", "default": "Pass" } diff --git a/schemas/bursar-export/filter/bursarExportFilterPatronGroup.json b/schemas/bursar-export/filter/bursarExportFilterPatronGroup.json index 9c54eb2..a544c66 100644 --- a/schemas/bursar-export/filter/bursarExportFilterPatronGroup.json +++ b/schemas/bursar-export/filter/bursarExportFilterPatronGroup.json @@ -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" } diff --git a/schemas/bursar-export/filter/bursarExportFilterServicePoint.json b/schemas/bursar-export/filter/bursarExportFilterServicePoint.json index eca73be..6c38e9d 100644 --- a/schemas/bursar-export/filter/bursarExportFilterServicePoint.json +++ b/schemas/bursar-export/filter/bursarExportFilterServicePoint.json @@ -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" } diff --git a/schemas/bursar-export/tokens/bursarExportTokenAggregate.json b/schemas/bursar-export/tokens/bursarExportTokenAggregate.json index 6ea388c..7e1fbc2 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenAggregate.json +++ b/schemas/bursar-export/tokens/bursarExportTokenAggregate.json @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenConditional.json b/schemas/bursar-export/tokens/bursarExportTokenConditional.json index c25ff5b..42b5d12 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenConditional.json +++ b/schemas/bursar-export/tokens/bursarExportTokenConditional.json @@ -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" } }, @@ -23,6 +27,7 @@ } }, "else": { + "description": "Data to represent if no condition is true", "$ref": "bursarExportDataToken.json" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenConstant.json b/schemas/bursar-export/tokens/bursarExportTokenConstant.json index 7899a10..271891d 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenConstant.json +++ b/schemas/bursar-export/tokens/bursarExportTokenConstant.json @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenCurrentDate.json b/schemas/bursar-export/tokens/bursarExportTokenCurrentDate.json index e0af891..5bbf6f2 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenCurrentDate.json +++ b/schemas/bursar-export/tokens/bursarExportTokenCurrentDate.json @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenFeeAmount.json b/schemas/bursar-export/tokens/bursarExportTokenFeeAmount.json index fb68c99..1f707cd 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenFeeAmount.json +++ b/schemas/bursar-export/tokens/bursarExportTokenFeeAmount.json @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenFeeDate.json b/schemas/bursar-export/tokens/bursarExportTokenFeeDate.json index ef201c2..f84af5b 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenFeeDate.json +++ b/schemas/bursar-export/tokens/bursarExportTokenFeeDate.json @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenFeeMetadata.json b/schemas/bursar-export/tokens/bursarExportTokenFeeMetadata.json index af75841..b98e33a 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenFeeMetadata.json +++ b/schemas/bursar-export/tokens/bursarExportTokenFeeMetadata.json @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenItemData.json b/schemas/bursar-export/tokens/bursarExportTokenItemData.json index ef100c3..50afa61 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenItemData.json +++ b/schemas/bursar-export/tokens/bursarExportTokenItemData.json @@ -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", @@ -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" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenLengthControl.json b/schemas/bursar-export/tokens/bursarExportTokenLengthControl.json index 3cd73b5..91c1261 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenLengthControl.json +++ b/schemas/bursar-export/tokens/bursarExportTokenLengthControl.json @@ -1,15 +1,18 @@ { - "description": "Token to fill in the length of another token", + "description": "Token to fill in or truncate the length of another token", "type": "object", "properties": { "character": { + "description": "Character to fill in with", "type": "string", "maxLength": 1 }, "length": { + "description": "Desired length for the token", "type": "integer" }, "direction": { + "description": "Direction to fill in or truncate from", "type": "string", "enum": [ "FRONT", @@ -17,6 +20,7 @@ ] }, "truncate": { + "description": "Whether to truncate the token if it is longer than the desired length", "type": "boolean" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenUserData.json b/schemas/bursar-export/tokens/bursarExportTokenUserData.json index 9b8402f..e8405c3 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenUserData.json +++ b/schemas/bursar-export/tokens/bursarExportTokenUserData.json @@ -3,14 +3,17 @@ "type": "object", "properties": { "type": { + "description": "Type of data token", "type": "string", "default": "UserData" }, "value": { + "description": "User data to represent", "type": "string", "enum": ["FOLIO_ID"] }, "lengthControl": { + "description": "Control length of token", "$ref": "bursarExportTokenLengthControl.json" } }, diff --git a/schemas/bursar-export/tokens/bursarExportTokenUserDataOptional.json b/schemas/bursar-export/tokens/bursarExportTokenUserDataOptional.json index b8be193..d62d1fa 100644 --- a/schemas/bursar-export/tokens/bursarExportTokenUserDataOptional.json +++ b/schemas/bursar-export/tokens/bursarExportTokenUserDataOptional.json @@ -3,17 +3,21 @@ "type": "object", "properties": { "type": { + "description": "Type of data token", "type": "string", "default": "UserDataOptional" }, "value": { + "description": "Optional user data to represent", "type": "string", "enum": ["BARCODE", "USERNAME", "FIRST_NAME", "MIDDLE_NAME", "LAST_NAME", "PATRON_GROUP_ID", "EXTERNAL_SYSTEM_ID"] }, "placeholder": { + "description": "Placeholder text to display when no value is present", "type": "string" }, "lengthControl": { + "description": "Control length of token", "$ref": "bursarExportTokenLengthControl.json" } }, diff --git a/schemas/bursar-export/transfer/bursarExportTransferCriteria.json b/schemas/bursar-export/transfer/bursarExportTransferCriteria.json index 883cd45..3d2de7a 100644 --- a/schemas/bursar-export/transfer/bursarExportTransferCriteria.json +++ b/schemas/bursar-export/transfer/bursarExportTransferCriteria.json @@ -3,14 +3,17 @@ "type": "object", "properties": { "conditions": { + "description": "Conditions to apply to the transfer of fees/fines", "type": "array", "items": { "type": "object", "properties": { "condition": { + "description": "Condition to apply tp this item", "$ref": "../filter/bursarExportFilter.json" }, "account": { + "description": "Account to transfer fees/fines that meet this condition to", "type": "string", "format": "uuid" } @@ -21,9 +24,10 @@ }, "else": { "type": "object", - "description": "account to transfer fees/fines that do not meet any specified conditions to", + "description": "If none of the specified conditions is met", "properties": { "account": { + "description": "Account to transfer fees/fines that do not meet any specified conditions to", "type": "string", "format": "uuid" }