LibertyDSNP / spec

The DSNP Spec and Website
https://spec.dsnp.org
Other
31 stars 3 forks source link

Chore/sync activity content spec/1 #172

Closed mehtaishita closed 2 years ago

mehtaishita commented 2 years ago

Problem

Make changes to address inconsistencies between ActivityContent package and Spec

https://github.com/LibertyDSNP/activity-content/issues/1

Solution

Making changes to the Activity Content portion of the spec to better clarify required values and parameter names

Change summary:

Steps to Verify:

  1. Build spec
  2. Verify changes are consistent across various attachment types - Audio, Video, Image
mehtaishita commented 2 years ago

From description of the ticket:

For ActvityContentHash - in spec value is required. In SDK we have dynamic values for key. - go with spec

For ActivityContentLocation - spec says name is required - SDK has name optional - so need to resolve - required

Both of these are required in the sdk so there are no changes to make there.

In the description, we also decided to not pluralize parameter names, so I have not renamed Video Link: Hash to Hashes. Please verify that decision

mehtaishita commented 2 years ago

As in change the variable names in activity-content to href?

wilwade commented 2 years ago

As in change the variable names in activity-content to href?

Right. The spec is correct, the code in activity content is wrong.

mehtaishita commented 2 years ago

I have reverted the renaming parameters for Associated Attachment types