api: update summaries of endpoints
@@ -32,7 +32,7 @@ paths:
/files:
get:
tags: ['ACH Files']
- summary: Get ACH files
+ summary: List Files
description: List all ACH files created with the ACH service. These files are not persisted through multiple runs of the service.
operationId: getFiles
security:
@@ -124,7 +124,7 @@ paths:
/files/{fileID}:
get:
tags: ['ACH Files']
- summary: Retrieve a file
+ summary: Retrieve File
description: Get the details of an existing File using the unique File identifier that was returned upon creation.
operationId: getFileByID
security:
@@ -155,7 +155,7 @@ paths:
description: A resource with the specified ID was not found
delete:
tags: ['ACH Files']
- summary: Delete file
+ summary: Delete File
description: Permanently deletes a File and associated Batches. It cannot be undone.
operationId: deleteACHFile
security:
@@ -183,7 +183,7 @@ paths:
/files/{fileID}/contents:
get:
tags: ['ACH Files']
- summary: Get file contents
+ summary: Get File Contents
description: |
Assembles the existing file (batches and controls) records, computes sequence numbers and totals. Returns plaintext file.
operationId: getFileContents
@@ -214,7 +214,7 @@ paths:
/files/{fileID}/validate:
get:
tags: ['ACH Files']
- summary: Validate file
+ summary: Validate File
description: Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
operationId: checkFile
security:
@@ -245,7 +245,7 @@ paths:
description: Validation failed. Check response for errors
post:
tags: ['ACH Files']
- summary: Validate file
+ summary: Validate File (Custom)
description: Validates the existing file. You need only supply the unique File identifier that was returned upon creation.
operationId: validateFile
security:
@@ -283,7 +283,7 @@ paths:
/files/{fileID}/segment:
post:
tags: ['ACH Files']
- summary: Segment file
+ summary: Segment File
description: Split one file into two. One with only debits and one with only credits.
operationId: segmentFile
security:
@@ -333,7 +333,7 @@ paths:
/files/{fileID}/flatten:
post:
tags: ['ACH Files']
- summary: Flatten batches
+ summary: Flatten Batches
description: Consolidate batches and entries into the minimum number of batches needed.
operationId: flattenFile
security:
@@ -376,7 +376,7 @@ paths:
/files/{fileID}/batches:
get:
tags: ['ACH Files']
- summary: Get batches
+ summary: Get Batches
description: Get the batches on a File.
operationId: getFileBatches
security:
@@ -410,7 +410,7 @@ paths:
$ref: '#/components/schemas/Batches'
post:
tags: ['ACH Files']
- summary: Add Batch to File
+ summary: Append Batch to File
description: Append a Batch record to the specified file
operationId: addBatchToFile
security:
@@ -487,7 +487,7 @@ paths:
description: Batch or File not found
delete:
tags: ['ACH Files']
- summary: Delete batch
+ summary: Delete Batch
description: Delete a Batch from a File
operationId: deleteFileBatch
security:
