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.

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

List of Property Definitions in "ActivityStreams 2.0 Terms" contains otherwise undocumented properties #525

Open
1 of 5 tasks
xenomachina opened this issue Dec 5, 2022 · 4 comments · May be fixed by #526
Open
1 of 5 tasks
Assignees

Comments

@xenomachina
Copy link

Please Indicate One:

  • Editorial
  • Question
  • Feedback
  • Blocking Issue
  • Non-Blocking Issue

Please Describe the Issue:

ActivityStreams 2.0 Terms, in §3. Property Definitions, contains a list of AS2.0 property names, each of which links to its definition in Activity Vocabulary.

The following properties appear in this list, but have broken links:

  • attachments
  • author
  • downstreamDuplicates
  • orderedItems
  • provider
  • rating
  • tags
  • upstreamDuplicates
  • verb

I searched in the following documents to see if I could find any mention of these properties:

Here's what I found:

  1. The following properties are only mentioned in JSON Activity Streams 1.0:

    • attachments
    • author
    • provider
    • rating
    • tags

    They are not mentioned at all in any of the AS 2.0 documentation that I can see (except for this list). There are other properties in AS1.0 that were removed but which are not mentioned in this list.

    Suggested fix: remove these from the list.

  2. The following properties...

    • downstreamDuplicates
    • verb
    • upstreamDuplicates

    ...are mentioned in Activity Streams 2.0, but only as being deprecated:

    This specification deprecates the upstreamDuplicates and downstreamDuplicates properties defined by Activity Streams 1.0 and does not provide a replacement.
    ...
    The terms displayName, verb, title and objectType should be treated as reserved terms that should not be used within Activity Streams 2.0 documents.

    There are other deprecated properties (like objectType) mentioned in the same place which are not mentioned in this list.

    Suggested fix: remove these from the list.

  3. Finally, orderedItems is not mentioned in Activity Vocabulary except in examples.

    However, it is documented in Activity Streams 2.0 in §4.6 Collection.

    Suggested fix: update the link.

@xenomachina
Copy link
Author

Also, given that orderedItems appears in this list, I wonder if:

  • the object form of natural language properties, nameMap, summaryMap, and contentMap, should be added to this list
  • preferredUsernameMap should be added to §4.1 ActivityPub.

xenomachina added a commit to xenomachina/activitystreams that referenced this issue Dec 5, 2022
The Property Definitions list in ns/index.html has several property
names with broken links. Remove the deprecated ones, and fix the
not-deprecated one.

Fixes w3c#525
@xenomachina xenomachina linked a pull request Dec 5, 2022 that will close this issue
@xenomachina
Copy link
Author

This PR implements the proposed fixes from above.

@gobengo
Copy link
Contributor

gobengo commented Aug 2, 2023

'as:attachment' and 'as:attachments' are both in the owl
https://github.com/w3c/activitystreams/blob/master/vocabulary/activitystreams2.owl#L52

notably the referent of the @context URI does not mention attachments

bengo@bengo ~ ⚡  curl -H "Accept: application/json" https://www.w3.org/ns/activitystreams | grep attachment
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100  7985  100  7985    0     0  18320      0 --:--:-- --:--:-- --:--:-- 18398
    "attachment": {
      "@id": "as:attachment",

ah but there is also this other file activitystreams1-context.jsonld that does define attachments
https://github.com/w3c/activitystreams/blob/master/ns/activitystreams1-context.jsonld#L9C25-L9C25

@evanp
Copy link
Collaborator

evanp commented Aug 2, 2023

@xenomachina this works pretty well. I think the principle that we should only include terms on this page that are defined in the context document is a righteous one.

We have a generator script in the GitHub repository. I'm going to re-run the script to make sure things compare correctly.

Since this is a non-normative document, we can make this change relatively easily.

@evanp evanp self-assigned this Aug 2, 2023
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 a pull request may close this issue.

3 participants