All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Upgraded to use OpenAPI Specification 3.1.
User
type had an inaccurate specification regarding permission attributes.
BulkUpload
is nowBulkUploadTask
.GET /bulkUpload
andPOST /bulkUpload
are nowGET /tasks/bulkUpload
andPOST /tasks/bulkUpload
. Future jobs for the graphile-worker will be routed undertasks
as well.
User
now has apermissions
attribute which includes information about various granted permissions.
SourceBundle
is now present in the swagger spec.GET /sources
is now correctly documented as returning aSourceBundle
.
Organization
is nowChangemaker
.OrganizationProposal
is nowChangemakerProposal
.
Users.id
no longer exists;keycloakUserId
is now the primary identifier of any givenUser
.Proposal.createdBy
is now a UUID reference to the creator'skeycloakUserId
.ProposalVersion.createdBy
is now a UUID reference to the creator'skeycloakUserId
.BulkUpload.createdBy
is now a UUID reference to the creator'skeycloakUserId
.
authenticationId
is nowkeycloakUserId
(a UUID) in theUser
entity, as well as for any endpoints that allowed filtering byauthenticationId
.
createdBy
is now an attribute ofProposalVersion
.
- New
Funder
entity type with correspondingPUT
andGET
endpoints. - New
DataProvider
entity type with correspondingPUT
andGET
endpoints. - New
Source
entity type with correspondingPUT
andGET
endpoints. sourceId
is now an attribute ofBulkUpload
.sourceId
is now an attribute ofProposalVersion
.
- The
BulkUploadBundle
entity now exists, and the/bulkUploads
endpoint is properly documented to return that type.
- Several read-only fields were improperly defined, resulting in improper SDK results.
WritablePresignedPostRequest
will no longer require a populatedpresignedPost
.
- Created a new
PresignedPost
entity type instead of directly embedding the definition inPresignedPostRequest
.
- The
Organizations
attributeemployerIdentificationNumber
has been removed.
- Several fields that were marked as optional are now properly marked as required.
BaseField
now has ascope
attribute.
- The GET
/opportunities
endpoint now returns anOpportunityBundle
and accepts pagination parameters. - Added a new
Organization
attributetaxId
which contains the same value asemployerIdentificationNumber
. - Deprecated the
Organizations
attributeemployerIdentificationNumber
. Please update your clients to usetaxId
instead.
- The
BulkUpload
entity now has acreatedBy
attribute. - The
Proposal
entity now has acreatedBy
attribute. - The
/proposals
endpoint now supports acreatedBy
filter. - The
User
type now exists. - The GET
/users
endpoint now exists.
- The
/bulkUploads
endpoint will now only return bulk uploads associated with the current user. - The
/proposals
endpoint will now only return proposals associated with the current user.
- The
data_type
field of theBaseField
entity is now an enum of acceptable types. - The
ProposalFieldValue
entity now has ais_valid
field.
- The
/applicationForms
endpoint now returns anApplicationFormBundle
. - The
/applicationForms
endpoint now returns deepApplicationForm
objects. - The
/applicationForms/:id
endpoint now returns a deep `ApplicationForm object.
- The
/applicationForms/:id
endpoint no longer has aincludeFields
query parameter, as it always includes deep fields.
- The
OrganizationProposal
entity now exists. - The
OrganizationProposalBundle
entity now exists. - It is now possible to filter
/proposals
in terms of organization. - It is now possible to filter
/organizations
in terms of proposal.
- The
Applicant
entity no longer exists. - All
/applicants/*
endpoints are removed. - The
applicantId
attribute ofProposal
has been removed.
- The
Organization
entity now exists. - The GET
/organizations
endpoint now exists. - The GET
/organizations:id
endpoint now exists. - The POST
/organizations
endpoint now exists.
- The
GET
andPOST
/canonicalFields
endpoints have been renamed to/baseFields
. - The
CanonicalField
schema type has been renamed toBaseField
. - The
ApplicationFormField.canonicalFieldId
attribute of the has been renamed toApplicationFormField.baseFieldId
.
- The
GET /proposals
endpoint now returns a newBundle
wrapper around response data.