From b0be86f541b166ee752be277608dbd2f65bfc041 Mon Sep 17 00:00:00 2001 From: Lisa Dusseault Date: Wed, 26 Jun 2024 15:11:13 -0700 Subject: [PATCH] Removes broken internal documentation link, adds new one, and adds more language suggested by jzacsh --- portability-types-transfer/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/portability-types-transfer/README.md b/portability-types-transfer/README.md index 256e4ce14..af9534d10 100644 --- a/portability-types-transfer/README.md +++ b/portability-types-transfer/README.md @@ -1,11 +1,13 @@ # portability-types-transfer -This folder contains the common data models that are used through out the DTP. +This folder contains the core DTP-framework interfaces used throughout the DTP's codebase. +For more general, common models see the `org.datatransferproject.types.common.models.*` +packages over in `/portability-types-common/src/main/java/org/datatransferproject/types/common/models/`. - [auth](src/main/java/org/datatransferproject/types/transfer/auth) - common data structures for passing auth data around the DTP system - - [models](src/main/java/org/datatransferproject/types/transfer/models) - - common data structures for encoding the data to be transferred + - [errors](src/main/java/org/datatransferproject/types/transfer/errors) - + common data structure for errors passed around or serialized - [retry](src/main/java/org/datatransferproject/types/transfer/retry) - common data structures for encoding the retry behavior for a server when there is an error.