GraphQL API
Features
-
We added three new filter field options for activityAssignments, which are accessible within the calendarMaps query:
- start - start date & time of the activity
- end - end date & time of the activity
- status - status of the activity (ie attending, pending, or not attending)
-
We changed the format of our Deprecation Reasons on GraphQL fields and enum values in our Core GraphQL API. Previously the deprecation reason was a plaintext string, but now leverages markdown to display a table of information including deprecation reason, date of deprecation, and date of removal. These dates are provided in ISO 8601 date format.
- For historically deprecated fields, the dates of removal and deprecation will be marked as TBD. Any updates on removal of these fields will be communicated in future release notes, and the date of deprecation and removal information on the schema will be updated accordingly.
Deprecation notices
- The CourseTemplate.accounts field has been deprecated and is scheduled for removal on June 13, 2023. It has been replaced by CourseTemplate.accountAssociations.
- The Portal.giftVoucherConfiguration field has been deprecated and scheduled for removal on June 13, 2023. It has been replaced by Portal.giftVoucherConfigurations.
- isTaxInclusiveOnly has been deprecated as a WebLink portal feature. This setting tells WebLink that prices set in Administrate include tax. Prices and taxes are set in Administrate, and the taxInclusive setting determines if prices are shown in WebLink with tax or not. This has now been removed on February 28, 2023.
Developer Portal
- A developer signed up and logged in to the Administrate Developer Portal can now choose to link their account to an instance of their choosing:
- Click the “Link Instance” button in your profile section
- Identify the instance you want to connect to and enter your username and password for that instance
- Once connected, you can run real queries against real instances
- The API documentation in the Developer Portal now makes it much clearer which parts of the Core GraphQL API are deprecated. It also now displays the date that a deprecated field will be removed.
- We fixed an issue in the Developer Portal where the values of enum types were not displaying in the API documentation.