bvanfleet / familyhistoryvault Goto Github PK

Description

In order to support collaboration between disparate databases -- currently, only with FHV databases -- a DTO model(s) need to be developed to capture collaborative data. Some of the collaborative data includes:

• User creating the note
• Subject reference
• Text
• Creation date

This collaboration can be attached to a document or person. This data may be derived from various models in the GEDCOM X spec, such as the Note model. The database may need to include id references and discriminators to support various subject types while keeping the database architecture flat.

Acceptance Criteria

• Collaboration DTO models are created
• Object mapping

Description

Creating a diagram for this system may help with better understanding the mapping between the GEDCOM X spec and the internal DTO spec. Additionally, this diagram may help identify the ideal database architecture.

Acceptance Criteria

• Diagrams stored in a /docs/diagrams folder.

Description

Users will need to be managed via the API with the following supported HTTP methods:

• HEAD
• GET
• POST
• PATCH
• DELETE

Additional models accessible from the users endpoints will include:

• Comments
• Changes (uploads, updates, etc.)

The response Content-Type for requests should default to application/fhv+json, with support for application/gedcom+json upon request. This is especially important if the user needs to export data from the system.

Acceptance Criteria

• User API endpoint created with desired methods

Dependencies

• #10 - Will provide the User model and mapping

Description

The User DTO model will be a top-level object that is based on the Agent GEDCOM X model. This will be utilized to track collaboration when genealogies are communicated between remote systems.

Acceptance Criteria

• User DTO class is created
• Mapping for Agent -> User flattening

Description

The Document DTO model is a top-level object based on the Document GEDCOM X model. It may also encapsulate additional metadata from the SourceDescription GEDCOM X model.

Acceptance Criteria

• Document DTO class is created
• Mapping for GedcomX.Document -> DataAccess.Document

Description

To be able to support third-party applications, like FamilySearch, a simple implementation of the GEDCOM X library will be added. This will be a model-only implementation. As development progresses, validations and additional logic can be added.

Acceptance Criteria

• FamilyHistoryVault.GedcomX library to be created.