add xAPIVersion property to top level profile properties #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -93,6 +93,7 @@ Property | Type | Description | Required | |||
| `@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 | |||
There was a problem hiding this comment.
The version -> The minimum version
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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"
imartinezortiz
added a commit
to imartinezortiz/xapi-profiles
that referenced
this pull request
Sep 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR for #9