This document lists breaking changes in Wyn API.

Wyn Enterprise v7.0 to v7.1

Following are the breaking changes in Server API V2.

1. The following public APIs are hidden in version 7.0 MU1.

• [POST] /api/v2/data/data-models/compare-datasources

• [POST] /api/v2/data/data-models/cache-models/sync

• [POST] /api/v2/data/data-models/intervals-column-info

2. A public HTTP request method is modified.

The current API content did not comply with the PUT specification (the definition of a PUT request is to replace the specified resource with the provided data), so we changed the request method from PUT to POST in the 7.1 version as shown:

Original: [PUT] /api/v2/common/documents/{id}/referenced-documents/update

Modified: [POST] /api/v2/common/documents/{id}/referenced-documents/update

Wyn Enterprise v6.1 to v7.0

There are no breaking changes in this release.

Wyn Enterprise v6.0 to v6.1

The following API has been removed from the GraphQL API:

/api/reporting/reports/{reportId}/bundle

Wyn Enterprise v5.1 to v6.0

There are no breaking changes in this release.

Wyn Enterprise v5.0 to v5.1

Following are the breaking changes in the GraphQL API.

1. The ops value of the grant for changePermissions mutation for the batch of documents is now changed to a string array from an enum array in earlier versions.

For example: [''Execute'']. This change is done to support custom permissions and roles from plugins.

Module

Server

Operation

mutation{
  changePermissions
}

Sample

mutation {
  changePermissions(
  documentIds: ["09cada19-978f-4a87-816f-b90bbe36cad2"],
  operationType: "AddNew",
  grant: [{ role: "3254c72f-2d7c-4781-abf9-184fc7cad340", ops:["Execute"]}])
}

2. The ops value of the grant for updatePermissions mutation for the batch of documents is now changed to a string array from an enum array in earlier versions.

For example: [''Execute'']. This change is done to support custom permissions and roles from plugins.

Module

Server

Operation

mutation{
  updatePermissions
}

Sample

mutation {
  UpdatePermissions(
  documentIds: ["09cada19-978f-4a87-816f-b90bbe36cad2"],
  operationType: "AddNew",
  grant: [{ role: "3254c72f-2d7c-4781-abf9-184fc7cad340", ops:["Execute"]}])
}

3. The return value of tagDocument mutation is now updated to string message from the document list.

This change has been done to improve the performance of the mutation.

Module

Server

Operation

mutation{
  tagDocument
}

Sample

mutation {
  tagDocument(
  tagId: "51b6d38c-4e6a-4c44-bf5c-f4bc904df652",
  documentId: "420cb224-8151-4fe6-a28e-b2b1d8fb93c5"
  )
}

Sample Response

{
  "data": {
  "tagDocument": "success"
  }
}

4. The return value of untagDocument mutation is now updated to string message from the document list.

This change is done to improve the performance of the mutation.

Module

Server

Operation

mutation{
  untagDocument
}

Sample

mutation {
  untagDocument(
  tagId: "51b6d38c-4e6a-4c44-bf5c-f4bc904df652",
  documentId: "420cb224-8151-4fe6-a28e-b2b1d8fb93c5"
 )
}

Sample Response

{
  "data": {
  "untagDocument": "success"
  }
}