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

Add Groop dataset site link #1

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

Conversation

groop-moray
Copy link

@groop-moray groop-moray commented Apr 15, 2021

Publishing Checklist

I confirm the following:

Maintenance Checklist

Our organisation is committed to:

  • Resolving issues that are raised on the GitHub Issues Board(s)
  • Ensuring activity providers are aware of the OpenActive opportunity on an ongoing basis

@nickevansuk
Copy link
Contributor

nickevansuk commented Apr 15, 2021

Thanks for submitting this for review!

The feed appears to be failing OpenActive Validator's model validation, and the dataset site itself also appears to be missing JSON-LD data (validation, Step 3 of Other Languages).

See the dataset site here for a good example, and search for <script type="application/ld+json"> in the source.

Please address these issues, and rerun validation by pressing "Rerun jobs" in the top right of this page - you should find it passes!

Let me know if you need any specific guidance around any of the errors reported by the validator.

@groop-moray
Copy link
Author

Thanks Nick. I'll take a look at those issues now. The dataset site was forked from https://github.com/openactive/dataset-site-template so I'm not sure why the JSON-LD data is missing?

@nickevansuk
Copy link
Contributor

nickevansuk commented Apr 16, 2021

Ah it's because the build script misses Step 1

See the line in the prototype code from the example:

    data.json = JSON.stringify(data, null, 2);

So you probably just want to have a small build script that does something like:

    var data = JSON.parse(fs.readFileSync('data.json', {encoding:'utf8'}));
    data.json = JSON.stringify(data, null, 2);

    //Use the resulting JSON with the mustache template to render the dataset site.
    var html = Mustache.render(template, data);
    fs.writeFileSync('index.html', html, {encoding:'utf8'});

@groop-moray
Copy link
Author

OK, I've updated our site, it should pass the validation now

@nickevansuk
Copy link
Contributor

Validation is still failing I'm afraid. It will not pass until all the tick boxes in the "Publishing Checklist" in this PR can be ticked.

Can you please confirm that you are passing the following, or let me know if you need any more help with these errors.

1. RPDE Validation: https://validator.openactive.io/rpde?url=https://api.groop.com/events

This error should be tackled first:

The next property "https://api.groop.com/events?afterTimeStamp=1617024092632&afterId=6c690c235f5345ebaa8905772" must not be equal to the current page URL "https://api.groop.com/events?afterTimeStamp=1617024092632&afterId=6c690c235f5345ebaa8905772" where there are more than zero items in the page. The last item in each page must be used to generate the next URL.

This video explains this, at 3:08.

2. Model Validation: https://validator.openactive.io/?url=https://api.groop.com/events

There are a number of errors listed here that must also be resolved

@nickevansuk
Copy link
Contributor

nickevansuk commented Apr 22, 2021

@groop-moray I should have mentioned earlier - if more interactive assistance would be helpful, please feel free to jump on https://slack.openactive.com/ - we can also schedule a call to talk through your implementation if you would find that useful

@groop-moray
Copy link
Author

I've updated our endpoint to match the spec, however I've noticed some discrepancies between the spec and the validator. The key one for us is that the spec says the location property of an Event (https://developer.openactive.io/data-model/types/event) may simple text data, however the validator says that it must be a Place. What should the location be?

@groop-moray
Copy link
Author

We've updated our endpoint to handled locations correctly and the validation now passes. Can you take a look again?

singular.jsonld Outdated Show resolved Hide resolved
@groop-moray
Copy link
Author

@nickevansuk Is there anything else that we need to do to get this PR merged?

@groop-moray
Copy link
Author

@nickevansuk can this PR be merged?

@nickevansuk
Copy link
Contributor

nickevansuk commented Jul 13, 2021

Apologies for the delay in reply! I've just rerun the test suite over this (see here) and there's an error that's getting in the way of it running completely. Hopefully this is resolved everything else will just pass!

This was due to an inconsistency between the tooling and documentation that has now been resolved - so all you need to do is add an @id property to the Event.

See https://developer.openactive.io/data-model/types/event for details.

@MorayM
Copy link

MorayM commented Sep 20, 2021

Hi Nick, we've updated the endpoint so Events now have the @id property.

@groop-moray
Copy link
Author

Hi @nickevansuk, any update on this?

@groop-moray
Copy link
Author

Hi @nickevansuk any update on this?

@nickevansuk
Copy link
Contributor

Hello @groop-moray - it looks like the feed now passes test suite, which is great. A couple of notes that are likely to prevent your feed being used however:

  1. The data in the feed appears to be test data
  2. The event pages should be targeted at the end user, helping them to verify the event information, rather than a login screen (see https://my.groop.com/ckmqi785yympg0794x6rngfw1/my-events/c003fa7d85ed40adbff0caa9d). See this example linked from the Bookwhen feed.
  3. The programme appears to be used instead of SessionSeries? Though this is unclear, as the programme url also appears to be pointing to an event page (and this page does not appear to be targeted at the end user, as it contains references to "open data").
  4. The value of isAccessibleForFree appears to contradict the available Offers

@groop-moray
Copy link
Author

Thanks for the feedback. We're using test data until the feed is approved - our customers don't want to use this feature until it is complete. We had several problems adhering to your schema as the validation tools and the documentation were often at odds. I'll go back to the team and see if we can schedule this work.

@nickevansuk
Copy link
Contributor

Hello @groop-moray ! Hope you're well - it's been a while! Apologies for the very long delay in reply, there was a funding gap for implementation support so we're only just coming back to this now.

What's the status of this? Is it still planned to go live?

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.

3 participants