Changelog for @pdc/service

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.

Unreleased

Changed

A changemaker now carries the keycloakOrganizationId, createdAt, and createdBy attributes, and its fiscalSponsors, only when the requester holds view permission on that changemaker. Every other requester, including an unauthenticated one, receives id, name, and taxId, plus fields where the endpoint returns it at all. This applies wherever a changemaker appears, not just at /changemakers: the changemakers embedded in a proposal, in a source, and in another changemaker’s fiscalSponsors are narrowed the same way. Permission is evaluated per changemaker, so a single array may hold both shapes.
fields remains an empty array for unauthenticated requests; it is kept in the response shape to support future visibility of public base field values.

0.42.0 2026-08-25

Added

Added an initiative entity representing a project led by a changemaker, managed via the /initiatives endpoints.
Added an initiativeFieldValue entity capturing base field data for an initiative, managed via the /initiatives/{initiativeId}/fieldValues endpoints.
Added an initiative permission scope, inherited from the owning changemaker, that governs who can view and edit initiatives.
Added an initiativeFieldValue permission scope, inherited from the owning initiative and changemaker, that governs who can view, create, and edit initiative field values.
Added a baseFieldCategory condition for grants scoped to initiativeFieldValue.

Removed

The platformProviderResponse entity no longer exists, along with the GET /platformProviderResponses and POST /platformProviderResponses endpoints. It predated changemakerFieldValues and was unused.

Fixed

POST /permissionGrants now accepts source as a scope for funder, changemaker, and dataProvider context entity types, matching the documented and database-supported behavior. Previously the handler rejected these grants with InputValidationError even though the SQL inheritance already supported source grants inherited from a source’s funder, changemaker, or data provider.

0.41.0 2026-07-24

Fixed

Paginated list endpoints no longer slow down as you request later pages.

Added

Proposal field value objects now include a proposalId attribute, so a value in a changemaker’s fields (or anywhere else a proposal field value appears) can be traced back to its proposal without an extra call to GET /proposalVersions/{proposalVersionId}.
Added a GET /funders/{memberFunderShortCode}/collaboratives endpoint that lists funder collaborative memberships for a given member funder.
Bulk upload CSVs may now include control:-prefixed columns (e.g. control:pdc_changemaker_id). Control columns carry meta-information that changes how a row is processed; they are exempt from application-form validation and are not stored as base fields.

Changed

pdc_changemaker_id is now expected as a control: column in a bulk-upload, rather than as a base field.
GET /permissionGrants now accepts optional filter query parameters: changemaker, funder, dataProvider, and proposal to filter by context entity, and granteeType and verb to filter by grantee. At most one context entity filter may be provided per request; providing more than one returns a 400.

0.40.0 2026-06-26

Added

Bulk uploads accept an optional pdc_changemaker_id column. When a row supplies a value in that column, the proposal is attached to that exact existing changemaker instead of matching/creating one by organization_tax_id + organization_name. An invalid or unknown id fails the task with a logged error.
Added a terminologySet entity that lets funders define custom display labels for opportunities, proposals, and application forms, managed via the /terminologySets endpoints.
Added a terminologySet permission scope, inherited from the owning funder, that governs who can view and edit terminology sets.
Opportunities can now reference a terminology set owned by the same funder.
Funders can now designate a default terminology set.

0.39.0 2026-06-24

Changed

Listing opportunities and bulk upload tasks no longer slows down as the number of permission grants grows.
Listing application forms and application form fields no longer slows down as the number of permission grants grows.
Listing sources no longer slows down as the number of permission grants grows.
Listing proposals and changemaker-proposal relationships no longer slows down as the number of permission grants grows.
Listing changemaker field values no longer slows down as the number of permission grants grows.
Listing permission grants no longer slows down as the number of permission grants grows.

Fixed

Funder collaborative endpoints now return 403 (or 404) instead of 401 when an authenticated user lacks permission.
POST /opportunities now returns 403 (or 404) instead of 401 when an authenticated user lacks permission on the associated funder.
POST /proposals now returns 403 (or 404) instead of 422 when an authenticated user lacks permission on (or cannot view) the associated opportunity.
POST /changemakerFieldValueBatches now returns 403 (or 404) instead of 422 when an authenticated user lacks permission to reference (or cannot view) the specified source.
POST /changemakerFieldValues now returns 403 when an authenticated user lacks permission to create field values for the specified changemaker, and 404 (instead of 409) when the changemaker, base field, or batch does not exist.
POST /changemakerProposals now returns 403 (instead of 422) when an authenticated user lacks permission on the funder associated with the proposal, and 404 (instead of 422) when the associated proposal cannot be viewed or does not exist.
POST /sources now returns 403 (instead of 422) when an authenticated user lacks permission to create a source for the specified funder, data provider, or changemaker, and 404 when that organization does not exist.
POST /proposalVersions now returns 403 (instead of 422) when an authenticated user lacks permission to edit the proposal or reference the source, and 404 (instead of 409) when the proposal, source, application form, or application form field cannot be viewed or does not exist. A 409 is now returned only when the application form or field is not associated with the proposal.
POST /tasks/bulkUploads now returns 403 (instead of 422) when an authenticated user lacks permission to create proposals for the application form’s opportunity or to reference the source, and 404 (instead of 422) when the application form, opportunity, or source cannot be viewed or does not exist.
POST /permissionGrants now returns 403 (instead of 401) when an authenticated user lacks permission to manage permission grants on the specified context entity, and 404 when that context entity cannot be viewed or does not exist.
PUT /permissionGrants/:permissionGrantId now returns 403 (instead of 401) when an authenticated user lacks permission to manage permission grants on the specified context entity, and 404 when that context entity cannot be viewed or does not exist.
POST /applicationForms now returns 403 (instead of 401) when an authenticated user lacks permission on the associated opportunity, and 404 (instead of 422) when that opportunity cannot be viewed or does not exist.
PATCH /applicationFormFields/:applicationFormFieldId now returns 403 (instead of 401) when an authenticated user lacks edit permission on the field’s application form.

0.38.0 2026-06-12

Fixed

Corrected the OpenAPI Organization.funder schema to reference the Funder schema instead of DataProvider. Documentation-only; no behavior change.
Corrected the OpenAPI Source schema to no longer list the non-existent relatedEntityId as a required property. Documentation-only; no behavior change.
Corrected the OpenAPI PresignedPost.fields schema to allow the dynamic S3 POST form fields (e.g. policy, x-amz-*) via additionalProperties. Documentation-only; no behavior change.
Corrected the OpenAPI BaseField schema to mark shortCode as readOnly (it used the misspelled, ignored read-only keyword). Documentation-only; no behavior change.
Corrected the OpenAPI BaseFieldLocalization schema: description and createdAt are no longer nullable, createdAt is now readOnly and required, and baseFieldShortCode is now readOnly, matching the actual payload. Documentation-only; no behavior change.
Corrected the OpenAPI BulkUploadTask.logs schema to describe an array of BulkUploadLog items (it previously used an invalid bundle-style properties.entries shape). Documentation-only; no behavior change.
Corrected the OpenAPI BulkUploadLog.details schema to reference BulkUploadLogDetails directly (it previously wrapped the reference in a spurious entries property). Documentation-only; no behavior change.
Corrected the OpenAPI BulkUploadLogDetails.cause schema to reference BulkUploadLogDetails recursively, matching the real nested-cause payload. Documentation-only; no behavior change.
Corrected the OpenAPI Opportunity schema to require funderShortCode and funder, which are always present in responses. Documentation-only; no behavior change.
Corrected the OpenAPI ProposalVersion schema to require source and createdBy, which are always present in responses. Documentation-only; no behavior change.
Corrected the OpenAPI FunderCollaborativeInvitation schema to require invitationStatus, which is always present in responses. Documentation-only; no behavior change.
Corrected the OpenAPI User.keycloakUserName schema to be nullable, matching the actual payload. Documentation-only; no behavior change.

0.37.0 2026-05-25

Fixed

Bulk upload processing no longer fails when a row leaves a file-typed field blank. The empty cell is stored as a non-file value (value: "", isValid: false) and no attachment lookup is attempted for that field.

Changed

GET /opportunities now accepts an optional funder query parameter to filter opportunities by funder shortCode.
Creating an entity now automatically grants the creator a manage permission with any scope on the new entity. This applies to opportunities, changemakers, proposals, sources, bulk upload tasks, application forms (and their fields), proposal versions (and their field values), and changemaker field values created via the HTTP API, as well as proposals, proposal versions, proposal field values, and newly inserted changemakers created during bulk upload processing.
Viewing application forms now requires explicit view | applicationForm scope, checked via a new has_application_form_permission function. The scope can be granted at the applicationForm, opportunity, or funder context level and is inherited appropriately. Previously this was implicitly granted by any view | opportunity grant.
Viewing application form fields now requires explicit view | applicationForm scope on the parent application form, checked via has_application_form_permission. Previously this was implicitly granted by any view | opportunity grant. Application form fields do not have their own independent permission scope; access to a field is determined entirely by access to its parent form.
POST /applicationForms now requires edit | applicationForm scope on the target opportunity instead of edit | opportunity.
PATCH /applicationFormFields/:applicationFormFieldId now requires edit | applicationForm scope on the parent application form instead of edit | opportunity.
Existing permission grants with opportunity scope on funder or opportunity contexts have been migrated to also include applicationForm scope. This preserves prior access for grantees who relied on opportunity-scoped grants for application form access.
/permissionGrants endpoints (list, read, create, update, delete) no longer require administrator role. Non-admin users holding the manage verb on a grant’s context entity may now list, read, create, update, and delete those grants. GET /permissionGrants filters results for non-admins to grants whose context entity they can manage. Updating a grant requires manage on both the existing and proposed context entity.
Standardized OpenAPI error responses onto shared, reusable components/responses referenced via $ref (with per-endpoint description overrides) instead of inline duplicates. Error responses now consistently document a PdcError body, and every authenticated endpoint documents a 401. Documentation-only; no behavior change.
Every endpoint now documents a 500 response via a shared, reusable InternalServerError component. Documentation-only; no behavior change.

0.36.0 2026-05-12

Added

Permission grant responses now include a createdByUser field containing the full user entity, similar to what we’ve
implemented for Bulk Uploads.

Changed

Upsert endpoints now distinguish a created row from an updated one via the HTTP response status: a fresh insert returns 201 Created, while updating an existing row returns 200 OK. This applies to PUT /baseFields/:shortCode, PUT /baseFields/:shortCode/localizations/:language, PUT /changemakers/:id/fiscalSponsors/:fiscalSponsorChangemakerId, PUT /dataProviders/:shortCode, PUT /funders/:shortCode, POST /funders/:shortCode/members/:memberFunderShortCode, and POST /funders/:shortCode/invitations/sent/:invitedFunderShortCode. Previously each endpoint returned a fixed status (some 200, some 201) regardless of whether a row was inserted or updated.

0.35.0 2026-05-05

Added

Added any to the permission grant entity type set. When any is included in a grant’s scope array, that grant satisfies any scope check on its context (e.g., view | any on a funder context grants view access for funder-, opportunity-, proposal-, and proposal-field-value-scoped data on that funder, including scope types added in the future). any is also recognized as a context entity type for forward compatibility but is not yet accepted by the API as a context.

Changed

GET /baseFields is now paginated in the same manner as all other GET endpoints. This is a breaking change. The endpoint can now take pagination parameters (_count, _page) and will return { entries , total } where entries is an array of base fields,
The manage permission verb now satisfies any verb check on the scope to which it is granted. A grantee with manage on a given scope no longer needs the other verbs listed alongside it to perform view, create, edit, delete, or reference operations at that scope. Scope matching is unchanged: manage does not grant access to scopes that are not explicitly included in the grant.

0.34.0 2026-04-23

Added

Add extension support in phone number validation.
Add changelog to documents that auto-publish to WordPress.
GET /funders now supports the isCollaborative query parameter to filter funders by their collaborative status.
Added a new reference verb to the permission grant verb set. Reference is intended to gate whether a user may cite an entity as a pointer in data they are creating, separate from view (which only grants read access) and create (which grants the ability to author new instances of an entity type).

Changed

All ID fields in the OpenAPI specification now reference a shared id schema with constraints (minimum: 1, maximum: 2147483647) instead of using bare integer types.
GET /sources and GET /sources/:sourceId now filter results by view | source permission; sources are no longer universally visible to authenticated users.
Source creation now requires create | source scope (previously required edit | funder, edit | changemaker, or edit | dataProvider). Existing permission grants with the parent entity’s scope have been migrated to also include source scope, and new create | source grants have been created for users who previously had edit verb on the parent entity.
POST /proposalVersions, POST /tasks/bulkUploads, and POST /changemakerFieldValueBatches now require a reference | source grant on the supplied source. Grants can be made directly on the source or inherited from the source’s funder, changemaker, or data provider. This is a breaking change: previous behavior allowed any authenticated user to supply any source, so existing users will need new reference | source grants before they can use these endpoints.

Fixed

baseFieldShortCode path parameters in base field localization endpoints were incorrectly typed as integer instead of shortCode.

0.33.0 2026-04-14

Added

Added createdBy field to funders, sources, opportunities, changemakers, and data providers.
BaseField can now be of type date and date_time.
GET /changemakers now supports the _content query parameter to search changemakers by name using full-text search.
Proposals now include a changemakers array containing shallow changemaker data for all associated changemakers.
Permission grants now support optional conditions that restrict which entities the grant applies to based on entity data. The initial implementation supports filtering proposalFieldValue scope by baseFieldCategory using the in operator.
Permission grants can now be updated via PUT /permissionGrants/:permissionGrantId. All mutable fields are replaced with the provided values.

Changed

Permission grants for users no longer require the user to exist in the PDC database. Grants can now reference any Keycloak user UUID, matching the existing behavior for user group grants.
ProposalVersion creation now requires edit | proposal scope (checked via has_proposal_permission) instead of edit | funder scope. Existing funder permission grants with edit verb and funder scope have been migrated to also include proposal scope.
Opportunity creation now requires create | opportunity scope on funder permission grants (previously edit | funder).
Viewing opportunities, application forms, application form fields, and bulk upload tasks now uses opportunity scope instead of funder scope.
Creating and editing application forms and application form fields now uses edit | opportunity scope instead of edit | funder.
Creating bulk upload tasks now requires create | proposal scope instead of edit | opportunity.
Application form field queries now enforce permission checks via has_opportunity_permission.
Existing funder permission grants with funder scope have been migrated to also include opportunity scope. New create | opportunity grants have been created for users who had edit | funder.
Creating changemaker field values now requires create | changemakerFieldValue scope (previously required edit | changemaker). This scope can be granted at the changemaker context level.
Existing changemaker permissions with changemaker scope have been migrated to also include changemakerFieldValue scope, ensuring backward compatibility.

Fixed

Bundle total now reflects the count of results matching the current query filters, permissions, and search terms. Previously it returned the full table row count regardless of any applied filters.
Permission checks for userGroup-based grants now correctly ignore expired ephemeral user group associations.

0.32.0 2026-02-20

Added

applicationFormField now has an inputType field to provide rendering hints for UIs rendering the fields.

0.31.0 2026-02-12

Added

GET /files endpoint to retrieve a paginated list of files. Users see only files they created; administrators can see all files and filter by creator using the createdBy parameter.
Added optional name field to ApplicationForm entity for human-readable display.

Changed

Viewing changemaker field values now requires explicit view | changemakerFieldValue scope, unless the field has public sensitivity classification. This scope can be granted at the changemaker context level.
Viewing proposal field values now requires explicit view | proposalFieldValue scope. This scope can be granted at the proposalFieldValue, proposal, opportunity, funder, or changemaker context level. Users with only view | proposal scope will see proposals with empty fieldValues arrays.
Existing permissions with proposal scope have been migrated to also include proposalFieldValue scope, ensuring backward compatibility.
Migrated changemaker permissions to the unified permission_grants table. Changemaker permissions should now be managed via the /permissionGrants endpoints.
Migrated funder permissions to the unified permission_grants table. Funder permissions should now be managed via the /permissionGrants endpoints.
Migrated data provider permissions to the unified permission_grants table. Data provider permissions should now be managed via the /permissionGrants endpoints.
Migrated opportunity permissions to the unified permission_grants table. Opportunity permissions should now be managed via the /permissionGrants endpoints.
The permissions property has been removed from the User type entirely. All permission checks are now performed asynchronously via the permission_grants table.
Viewing proposals, proposal versions, and changemaker-proposal associations now requires view | proposal scope instead of inheriting from view | funder or view | changemaker. The view | proposal scope can be granted at the proposal, opportunity, funder, or changemaker context level and will be inherited appropriately.

Removed

Legacy changemaker permission endpoints have been removed:
- PUT /users/{userKeycloakUserId}/changemakers/{changemakerId}/permissions/{permission}
- DELETE /users/{userKeycloakUserId}/changemakers/{changemakerId}/permissions/{permission}
- PUT /userGroups/{keycloakOrganizationId}/changemakers/{changemakerId}/permissions/{permission}
- DELETE /userGroups/{keycloakOrganizationId}/changemakers/{changemakerId}/permissions/{permission}
UserChangemakerPermission and UserGroupChangemakerPermission schemas have been removed from the OpenAPI spec.
Legacy funder permission endpoints have been removed:
- PUT /users/{userKeycloakUserId}/funders/{funderShortCode}/permissions/{permission}
- DELETE /users/{userKeycloakUserId}/funders/{funderShortCode}/permissions/{permission}
- PUT /userGroups/{keycloakOrganizationId}/funders/{funderShortCode}/permissions/{permission}
- DELETE /userGroups/{keycloakOrganizationId}/funders/{funderShortCode}/permissions/{permission}
UserFunderPermission and UserGroupFunderPermission schemas have been removed from the OpenAPI spec.
Legacy data provider permission endpoints have been removed:
- PUT /users/{userKeycloakUserId}/dataProviders/{dataProviderShortCode}/permissions/{permission}
- DELETE /users/{userKeycloakUserId}/dataProviders/{dataProviderShortCode}/permissions/{permission}
- PUT /userGroups/{keycloakOrganizationId}/dataProviders/{dataProviderShortCode}/permissions/{permission}
- DELETE /userGroups/{keycloakOrganizationId}/dataProviders/{dataProviderShortCode}/permissions/{permission}
UserDataProviderPermission and UserGroupDataProviderPermission schemas have been removed from the OpenAPI spec.
Legacy opportunity permission endpoints have been removed:
- PUT /users/{userKeycloakUserId}/opportunities/{opportunityId}/permissions/{opportunityPermission}
- DELETE /users/{userKeycloakUserId}/opportunities/{opportunityId}/permissions/{opportunityPermission}
- PUT /userGroups/{keycloakOrganizationId}/opportunities/{opportunityId}/permissions/{opportunityPermission}
- DELETE /userGroups/{keycloakOrganizationId}/opportunities/{opportunityId}/permissions/{opportunityPermission}
UserOpportunityPermission and UserGroupOpportunityPermission schemas have been removed from the OpenAPI spec.

Fixed

Changemaker.fields file values are now decorated with downloadUrl to allow access to file contents.
ChangemakerProposal.proposal.versions[].fieldValues file values are now decorated with downloadUrl.

0.30.0 2026-01-27

Added

PermissionGrant entity type now exists to represent permission grants that give a user or user group specific permissions on a context entity and its related entities.
GET /permissionGrants endpoint now exists to retrieve a paginated list of permission grants. Requires administrator role.
POST /permissionGrants endpoint now exists to create a new permission grant. Requires administrator role.
GET /permissionGrants/{permissionGrantId} endpoint now exists to retrieve a specific permission grant by ID. Requires administrator role.
DELETE /permissionGrants/{permissionGrantId} endpoint now exists to delete a specific permission grant by ID. Requires administrator role.
PermissionGrantEntityType schema now exists to enumerate entity types that can be referenced in permission grants.
PermissionGrantVerb schema now exists to enumerate permission verbs (view, create, edit, delete, manage).

0.29.0 2025-01-23

Added

GET /applicationForm/{applicationFormId}/proposalDataCsv returns an application form in a usable csv format for making bulk uploads
applicationFormId is now a field on bulkUploadTasks

Changed

ApplicationForms are no longer created during a bulk upload, and bulk uploads must now explicitly reference an existing application form on creation.

0.28.0 2025-01-08

Added

ChangemakerFieldValueBatch entities now have a createdBy attribute tracking the user who created the batch.
GET /changemakerFieldValueBatches endpoint now exists to retrieve a paginated list of changemaker field value batches.
GET /changemakerFieldValueBatches/:batchId endpoint now exists to retrieve a specific changemaker field value batch by ID.
GET /changemakerFieldValues endpoint now exists to retrieve a paginated list of changemaker field values with optional filtering by changemakerFieldValueBatch and changemaker.
GET /changemakerFieldValues/:fieldValueId endpoint now exists to retrieve a specific changemaker field value by ID.
FieldValueBase type now exists as a common base for ProposalFieldValue and ChangemakerFieldValue.
Changemaker.fields now includes ChangemakerFieldValue objects in addition to ProposalFieldValue objects, with source-based priority determining the “gold” value per base field.

Changed

ProposalFieldValue and ChangemakerFieldValue OpenAPI schemas now use allOf to extend FieldValueBase.
Changemaker.fields OpenAPI schema now uses oneOf to accept either ProposalFieldValue or ChangemakerFieldValue items.

0.27.0 2025-12-22

Added

ChangemakerFieldValueBatch entity type now exists to group changemaker field values that were imported together from an external source.
POST /changemakerFieldValueBatches endpoint now exists to create changemaker field value batches.
ChangemakerFieldValue entity type now exists to represent field values directly associated with changemakers.
POST /changemakerFieldValues endpoint now exists to create changemaker field values.

0.26.0 2025-10-30

Added

GET /baseFields now has an optional sensitivityClassifications parameter.
GET /baseFields by default returns non-forbidden base fields.

0.25.5 2025-10-22

Added

BulkUpload entities now have a createdByUser attribute.

0.25.4 2025-10-22

Fixed

POST /changemakers OpenAPI documentation was improved.

0.25.3 2025-10-22

Added

File entities are now decorated with a downloadUrl when appropriate.

Fixed

File is now properly documented as potentially having a presignedPost attribute.

0.25.2 2025-10-21

Added

ProposalFieldValue now includes a file attribute if the field value references a valid File.

0.25.1 2025-10-10

Added

BulkUploadTask now accepts a nullable attachmentsArchiveFileId.

0.25.0 2025-10-03

Added

GET /tasks/bulkUploads now includes BulkUploadLog entries under logs.

0.24.1 2025-09-11

Added

BaseField can now be of type file.
S3Bucket now exists.

Fixed

BaseField is now properly documented as being allowed to be type currency.

Changed

File now has an s3BucketName attribute as well as an s3Bucket attribute, and no longer has a has a bucketName or bucketRegion attribute.
BulkUploadTask no longer stores file metadata, but instead requires a proposalsDataFileId attribute which references a File.id.

0.23.0 2025-08-29

Changed

/presignedPostRequests has been renamed to /files and the returned File entity has additional attributes.

0.22.1 2025-08-15

Added

Proposal entities now include deep Opportunity data.

Fixed

The required fields associated with UserGroupChangemakerPermission, UserGroupDataProviderPermission, and UserGroupFunderPermission are now correctly documented.
The various opportunity permission endpoints are now correctly documented.

0.22.0 2025-07-22

Funders now have a isCollaborative attribute.
Added FunderCollaborativeMember entity type to represent collaborators on Funders, which extend funder permissions to other funder collaborators.
Added FunderCollaborativeInvitation entity type to represent invitations to collaborate on a funder.

0.21.0 2025-07-16

Added

A new PUT /users/{userId}/opportunities/{opportunityId}/permissions/{opportunityPermission} endpoint now exists
A new DELETE /users/{userId}/opportunities/{opportunityId}/permissions/{opportunityPermission} endpoint now exists
A new PUT /userGroups/{keycloakOrganizationId}/opportunities/{opportunityId}/permissions/{opportunityPermission} endpoint now exists
A new DELETE /userGroups/{keycloakOrganizationId}/opportunities/{opportunityId}/permissions/{opportunityPermission} endpoint now exists

0.20.2 2025-07-10

Added

ApplicationFormField now have an instructions attribute.

0.20.1 2025-07-10

Added

GET /proposals now accepts a funder querystring filter which returns a subset of proposals based on the funder of the proposal’s opportunity.

0.20.0 2025-06-17

Changed

The BaseField.scope attribute is now BaseField.category and includes several additional values.

0.19.0 2025-06-17

Added

ProposalFieldValues now have a goodAsOf attribute.
BaseFields now have a sensitivityClassification attribute.

0.18.0 2025-04-28

Changed

BaseFields are now primary keyed on the shortCode value, and have had corresponding
foreign keys in the ApplicationFormField and BaseFieldLocalization tables updated to match.

0.17.1 2025-04-21

Added

BaseFields now have a valueRelevanceHours attribute which signal how long values associated with the base field are considered relevant.

0.17.0 2025-02-13

Changed

Opportunity and BulkUploadTask now require a funderShortCode on creation.

0.16.8 2025-02-13

Added

Add and remove fiscal sponsors using PUT and DELETE on /changemakers/{changemakerId}/fiscalSponsors/{fiscalSponsorChangemakerId}.
There is now a type ShallowChangemaker available.
Changemaker now has a fiscalSponsors attribute, a list of ShallowChangemaker.

0.16.7 2025-02-05

Added

Manage user-funder permissions using PUT, and DELETE on /user/{keycloakUserId}/funders/{funderShortCode}/permissions/{permission}.
Manage user-data-provider permissions using PUT, and DELETE on /user/{keycloakUserId}/funders/{funderShortCode}/permissions/{permission}.
Manage user-group-changemaker permissions using PUT, and DELETE on /userGroups/{keycloakOrganizationId}/changemaker/{changemakerId}/permissions/{permission}.
Manage user-group-data-provider permissions using PUT, and DELETE on /userGroups/{keycloakOrganizationId}/dataProvider/{dataProviderShortCode}/permissions/{permission}
Manage user-group-funder permissions using PUT, and DELETE on /userGroups/{keycloakOrganizationId}/funders/{funderShortCode}/permissions/{permission}
Manage user-funder permissions using PUT, and DELETE on /user/{keycloakUserId}/funders/{funderShortCode}/permissions/{permission}.
Update changemaker attributes using PATCH on /changemakers/{changemakerId}. This was available in the API starting 2025-01-30 under the previous version number.

0.16.6 2024-12-23

Changed

Changemaker now has keycloakOrganizationId, the UUID in Keycloak for the related Organization.

0.16.5 2024-12-23

Changed

Funder now has keycloakOrganizationId, the UUID in Keycloak for the related Organization.

0.16.4 2024-12-23

Changed

Upgraded to use OpenAPI Specification 3.1.
DataProvider type now has keycloakOrganizationId, the UUID in Keycloak for the related Organization.

Added

Manage user changemaker permissions using GET, PUT, and DELETE on /user/{keycloakUserId}/changemakers/{changemakerId}/permissions/{permission}.

0.16.3 2024-12-02

Fixed

Changemaker type was missing the fields property.

0.16.2 2024-11-12

Fixed

User type had an inaccurate specification regarding permission attributes.

0.16.1 2024-11-07

Changed

BulkUpload is now BulkUploadTask.
GET /bulkUpload and POST /bulkUpload are now GET /tasks/bulkUpload and POST /tasks/bulkUpload.
Future jobs for the graphile-worker will be routed under tasks as well.

0.16.0 2024-11-7

Added

User now has a permissions attribute which includes information about various granted permissions.

0.15.1 2024-10-28

Fixed

SourceBundle is now present in the swagger spec.
GET /sources is now correctly documented as returning a SourceBundle.

0.15.0 2024-10-14

Changed

Organization is now Changemaker.
OrganizationProposal is now ChangemakerProposal.

0.14.0 2024-10-11

Changed

Users.id no longer exists; keycloakUserId is now the primary identifier of any given User.
Proposal.createdBy is now a UUID reference to the creator’s keycloakUserId.
ProposalVersion.createdBy is now a UUID reference to the creator’s keycloakUserId.
BulkUpload.createdBy is now a UUID reference to the creator’s keycloakUserId.

0.13.0 2024-09-26

Changed

authenticationId is now keycloakUserId (a UUID) in the User entity, as well as for any endpoints that allowed filtering by authenticationId.

0.12.4 2024-09-19

Added

createdBy is now an attribute of ProposalVersion.

0.12.3 2024-09-19

Added

New Funder entity type with corresponding PUT and GET endpoints.
New DataProvider entity type with corresponding PUT and GET endpoints.
New Source entity type with corresponding PUT and GET endpoints.
sourceId is now an attribute of BulkUpload.
sourceId is now an attribute of ProposalVersion.

0.11.0 2024-05-20

Added

The BulkUploadBundle entity now exists, and the /bulkUploads endpoint is properly documented to return that type.

Fixed

Several read-only fields were improperly defined, resulting in improper SDK results.
WritablePresignedPostRequest will no longer require a populated presignedPost.

Changed

Created a new PresignedPost entity type instead of directly embedding the definition in PresignedPostRequest.

0.10.0 2024-05-03

Removed

The Organizations attribute employerIdentificationNumber has been removed.

0.9.1 2024-05-03

Changed

Several fields that were marked as optional are now properly marked as required.

0.9.0 2024-05-02

Added

BaseField now has a scope attribute.

Changed

The GET /opportunities endpoint now returns an OpportunityBundle and accepts pagination parameters.
Added a new Organization attribute taxId which contains the same value as employerIdentificationNumber.
Deprecated the Organizations attribute employerIdentificationNumber. Please update your clients to use taxId instead.

0.8.0 2024-04-23

Added

The BulkUpload entity now has a createdBy attribute.
The Proposal entity now has a createdBy attribute.
The /proposals endpoint now supports a createdBy filter.
The User type now exists.
The GET /users endpoint now exists.

Changed

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.

0.7.0 2024-04-04

Changed

The data_type field of the BaseField entity is now an enum of acceptable types.
The ProposalFieldValue entity now has a is_valid field.

0.6.0 2024-03-29

Changed

The /applicationForms endpoint now returns an ApplicationFormBundle.
The /applicationForms endpoint now returns deep ApplicationForm objects.
The /applicationForms/:id endpoint now returns a deep `ApplicationForm object.

Removed

The /applicationForms/:id endpoint no longer has a includeFields query parameter, as it always includes deep fields.

0.5.0 – 2024-03-27

Added

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.

0.4.0 – 2024-02-29

Removed

The Applicant entity no longer exists.
All /applicants/* endpoints are removed.
The applicantId attribute of Proposal has been removed.

0.3.1 – 2024-02-29

Added

The Organization entity now exists.
The GET /organizations endpoint now exists.
The GET /organizations:id endpoint now exists.
The POST /organizations endpoint now exists.

0.3.0 – 2023-05-03

Changed

The GET and POST /canonicalFields endpoints have been renamed to /baseFields.
The CanonicalField schema type has been renamed to BaseField.
The ApplicationFormField.canonicalFieldId attribute of the has been renamed to ApplicationFormField.baseFieldId.

0.2.0 – 2023-04-20

Changed

The GET /proposals endpoint now returns a new Bundle wrapper around response data.

This content was automatically generated from GitHub. Any edits made on WordPress will be lost.