Open-Cap-Format-OCF icon indicating copy to clipboard operation
Open-Cap-Format-OCF copied to clipboard
verified publisher icon Open-Cap-Table-Coalition

add a schema for a Documents file (paths only) to be included in OCF

Open jacobyavis opened this issue 1 year ago • 4 comments

Proposal

proposal for a Documents file to be included in OCF to support mapping of documents to stakeholders and their related securities (note: documents themselves still remain outside of OCF, we are just mapping by way of the path/filename)

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR allows us to start relating document (paths/filenames) with stakeholders, and optionally to their related securities.

  • We are NOT proposing to start packaging documents inside of an OCF container
  • We ARE proposing there is value in being able to specify filepaths and where they relate to, such that an issuer could provide a separate archive/container/file-repository which these filepaths can be used with

Which issue(s) this PR fixes:

Fixes #496

jacobyavis avatar May 02 '24 17:05 jacobyavis

Per TWG: @jacobyavis to update so that documents reference:

  1. An array of OCF objects,
  2. Polymorphically by ID+object type

pjohnmeyer avatar May 07 '24 16:05 pjohnmeyer

I've made the changed suggested from preliminary review on May 7th Marking this PR ready now, please review

jacobyavis avatar May 24 '24 18:05 jacobyavis

There were comments from last meeting about adding a file hash field, as well as a URI field (both optional)

jacobyavis avatar Jun 20 '24 16:06 jacobyavis

Looking for review (@JSv4 or @pjohnmeyer ?) following the implementation of @mrosendin's uri and md5 suggestion

jacobyavis avatar Jul 16 '24 20:07 jacobyavis