Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to expand and clarify determining properties #258

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Updates to expand and clarify determining properties #258

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a62b9f4
Made Changes to Expand Determining Properties
andyjohnson Jun 1, 2022
f13bfb3
Added Statement Template Properties/References
andyjohnson Jun 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Added Statement Template Properties/References
  • Loading branch information
@andyjohnson
andyjohnson authored Jun 1, 2022
commit f13bfb381b4ef395e1f9ce8a3cc2efa4eed8eb71
9 changes: 5 additions & 4 deletions xapi-profiles-structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,9 +447,10 @@ Property | Type | Description | Required
`verb` | IRI | Verb IRI | Optional
`objectActivityType` | IRI | Object activity type IRI | Optional
`homepage` | IRL | Part of the Account object | Optional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should get expanded to cover all IFIs

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment from the group on 6/7/2022 - should be all of the IFIs or none.

`ActivityDefinitionExtension` key | IRI | The key of the extension of the Activity Definition Object | Optional
`ResultExtension` key | IRI | The key of the extension of the Result Object | Optional
`ContextExtension` key | IRI | The key of the extension of the Context Object | Optional
`activityDefinitionExtension` key | IRI | The key of the extension of the Activity Definition Object | Optional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this description needs to be a little more specific or reworded. Its not clear to me if this is specifically the Statement Object Activity or any Activity in the statement.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

6/7/2022 - this can be for any Object (type of Activity), not just the Object of the Statement.

`resultExtension` key | IRI | The key of the extension of the Result Object | Optional
`contextExtension` key | IRI | The key of the extension of the Context Object | Optional
`contextCategoryContextActivity` key | IRI | The identifier of the Category Context Activity | Optional
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be renamed (e.g. "profileVersion", "profileReference", etc.) to indicate its a profile version id/iri instead of an arbitrary category activity id. I also think this should be an array so that multiple references can be specified.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per 6/7/2022 , the first part of the comment is for line 453 and the second part is for 451-453. Multiple references should be allowed.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So should be "Arrays"

`objectActivityType` | IRI | Object activity type IRI | Optional
`contextGroupingActivityType` | Array | Array of contextActivities grouping activity type IRIs | Optional
`contextParentActivityType` | Array | Array of contextActivities parent activity type IRIs | Optional
Expand All @@ -462,7 +463,7 @@ Property | Type | Description | Required

A Statement Template MUST NOT have both `objectStatementRefTemplate` and `objectActivityType`.

The verb, object activity type, attachment usage types, and context activity types listed are called Determining Properties.
The verb, object activity type, homepage, extensions, category context activity, attachment usage types, and context activity types listed are called Determining Properties.

A Profile Author MUST change a Statement Template's `id` between versions if any of the Determining Properties, StatementRef properties, or rules change.
Changes of `scopeNote` are not considered changes in rules.
Expand Down