Skip to content

add xAPIVersion property to top level profile properties#10

Open
FeLungs wants to merge 1 commit into
masterfrom
xapi_version
Open

add xAPIVersion property to top level profile properties#10
FeLungs wants to merge 1 commit into
masterfrom
xapi_version

Conversation

@FeLungs

@FeLungs FeLungs commented Jan 9, 2023

Copy link
Copy Markdown
Owner

PR for #9

`@context` | URI | SHOULD be `https://w3id.org/xapi/profiles/context` and MUST contain this URI if array-valued. | Required
`type` | String | MUST be `Profile`. | Required
`conformsTo` | URI | Canonical URI of the Profile specification version conformed to. The Profile specification version of this document is https://w3id.org/xapi/profiles#1.0. | Required
`xAPIVersion` | Array | The version of xAPI this profile adheres to. When not provided, the Profile MUST adhere to the most recent version of xAPI | Optional

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The version -> The minimum version

@imartinezortiz imartinezortiz Jan 13, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I guess, that we want to make the property Optional to be backwards compatible, but way may suggest a default value instead i ? (e.g. 2.0), this seems in line with https://github.com/FeLungs/xapi-profiles/pull/11/files#diff-606540b1af5b129ddbd1feb844096fa258d30a68adaa1cdecbb0279c418773d9R514

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

make this explicit (2.0) and then add language that this is the default and can be changed based on the needs of the profile author.

When future versions come out, a profile that ref set 2.0 as xAPIVersion. 2.0 may be valid 2.1 but 2.1 may not be valid 2.0

add meaning of "minimum"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants