API Change Log - PLATFORM Module

🧩 Service: `Authorization`

🔧 Operation: `resendCompanyInvite`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.meta.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.meta.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.created_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 5

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite
Schema Action: PROPERTY_ADDED
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.error
New Schema:

{
  "type": "string",
  "description": "Any error message associated with the invite"
}

🔹 Change 6

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.meta.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 7

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.meta.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 8

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.created_at.format
New Schema:

"date-time"

🔹 Change 9

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite
Schema Action: PROPERTY_ADDED
Path: paths.resendCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.error
New Schema:

{
  "type": "string",
  "description": "Any error message associated with the invite"
}

🔧 Operation: `createCompanyInvite`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.createCompanyInvite.methodTypePlaceHolder.parameters.1
New Schema:

{
  "in": "query",
  "name": "platform",
  "schema": {
    "type": "string"
  },
  "examples": {
    "create company invite success": {
      "value": "fynd"
    }
  }
}

🔹 Change 2

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 3

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 4

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 5

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 6

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 9

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔧 Operation: `getCompanyInvite`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.meta.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.meta.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.created_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 5

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite
Schema Action: PROPERTY_ADDED
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invites.items.properties.error
New Schema:

{
  "type": "string",
  "description": "Any error message associated with the invite"
}

🔹 Change 6

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.meta.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 7

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.meta.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 8

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.created_at.format
New Schema:

"date-time"

🔹 Change 9

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite
Schema Action: PROPERTY_ADDED
Path: paths.getCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.error
New Schema:

{
  "type": "string",
  "description": "Any error message associated with the invite"
}

🔧 Operation: `deleteCompanyInvite`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.deleteCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.meta.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.deleteCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.meta.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.deleteCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.created_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.deleteCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 5

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite
Schema Action: PROPERTY_ADDED
Path: paths.deleteCompanyInvite.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.invite.properties.error
New Schema:

{
  "type": "string",
  "description": "Any error message associated with the invite"
}

🔧 Operation: `sendCompanyInvite`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.sendCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.sendCompanyInvite.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔧 Operation: `getStaffMembersList`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.getStaffMembersList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.getStaffMembersList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMembersList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMembersList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 5

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffResponseSchema --> Page
Schema Action: PROPERTY_ADDED
Path: paths.getStaffMembersList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.limit
New Schema:

{
  "type": "integer",
  "format": "int32",
  "description": "The maximum number of items to be returned per page.",
  "example": 10
}

🔹 Change 6

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffResponseSchema --> Page
Schema Action: PROPERTY_ADDED
Path: paths.getStaffMembersList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
New Schema:

{
  "type": "integer",
  "format": "int32",
  "description": "Total number of items.",
  "example": 1
}

🔹 Change 7

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMembersList.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/staff"

🔧 Operation: `updateCompanyStaff`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.updateCompanyStaff.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.updateCompanyStaff.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 5

Action: remove
Type: breaking
xGroup: N/A
Schema Ref: StaffUpdateResponse
Schema Action: PROPERTY_REMOVED
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.onwer

🔹 Change 6

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 7

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 8

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.created_at.format
New Schema:

"date-time"

🔹 Change 9

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.modified_at.format
New Schema:

"date-time"

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffUpdate
Schema Action: PROPERTY_ADDED
Path: paths.updateCompanyStaff.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.employee_code
New Schema:

{
  "type": "string",
  "description": "The code assigned to the employee",
  "x-not-enum": true
}

🔹 Change 11

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateCompanyStaff.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/staff"

🔧 Operation: `createRole`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 5

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 6

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 9

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 11

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 12

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 13

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 14

Action: remove
Type: non-breaking
xGroup: N/A
Schema Ref: Role
Schema Action: OPERATION_ID_REMOVED
Path: paths.createRole.methodTypePlaceHolder.requestBody.content.application/json.schema.required.5

🔹 Change 15

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 16

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 17

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 18

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 19

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 20

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 21

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 22

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 23

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 24

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 25

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 26

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 27

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 28

Action: remove
Type: non-breaking
xGroup: N/A
Schema Ref: Role
Schema Action: OPERATION_ID_REMOVED
Path: paths.createRole.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5

🔹 Change 29

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.createRole.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/role"

🔧 Operation: `getRolesList`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at.format
New Schema:

"date-time"

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 5

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 6

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 9

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 11

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 12

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 13

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 14

Action: remove
Type: non-breaking
xGroup: N/A
Schema Ref: Role
Schema Action: OPERATION_ID_REMOVED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.required.5

🔹 Change 15

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffResponseSchema --> Page
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.limit
New Schema:

{
  "type": "integer",
  "format": "int32",
  "description": "The maximum number of items to be returned per page.",
  "example": 10
}

🔹 Change 16

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffResponseSchema --> Page
Schema Action: PROPERTY_ADDED
Path: paths.getRolesList.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.page.properties.total
New Schema:

{
  "type": "integer",
  "format": "int32",
  "description": "Total number of items.",
  "example": 1
}

🔹 Change 17

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRolesList.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/role"

🔧 Operation: `updateRole`

🔹 Change 1

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateRole.methodTypePlaceHolder.parameters.1.name
New Schema:

"role_title"

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 4

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 5

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 6

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 9

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 11

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 12

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 13

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 14

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 15

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 16

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 17

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 18

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 19

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 20

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 21

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 22

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 23

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 24

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 25

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 26

Action: remove
Type: non-breaking
xGroup: N/A
Schema Ref: Role
Schema Action: OPERATION_ID_REMOVED
Path: paths.updateRole.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5

🔹 Change 27

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.updateRole.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/role/{role_title}"

🔧 Operation: `getRole`

🔹 Change 1

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRole.methodTypePlaceHolder.parameters.1.name
New Schema:

"role_title"

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 5

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 6

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 9

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 11

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 12

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 13

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 14

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 15

Action: remove
Type: non-breaking
xGroup: N/A
Schema Ref: Role
Schema Action: OPERATION_ID_REMOVED
Path: paths.getRole.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5

🔹 Change 16

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getRole.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/role/{role_title}"

🔧 Operation: `deleteRole`

🔹 Change 1

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.deleteRole.methodTypePlaceHolder.parameters.1.name
New Schema:

"role_title"

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 5

Action: add
Type: breaking
xGroup: N/A
Schema Ref: Role --> RoleExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "all",
  "specific"
]

🔹 Change 6

Action: replace
Type: breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: DATA_TYPE_UPDATED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.stores.items.type
New Schema:

"number"

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "number",
  "description": "ID of the company associated with the permission"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.user
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the user"
}

🔹 Change 9

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.type
New Schema:

{
  "type": "string",
  "description": "The type of the user"
}

🔹 Change 10

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties._id
New Schema:

{
  "type": "string",
  "description": "The unique identifier for the application permission"
}

🔹 Change 11

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user within the application or not"
}

🔹 Change 12

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.created_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was created",
  "format": "date-time"
}

🔹 Change 13

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.modified_at
New Schema:

{
  "type": "string",
  "description": "Timestamp when the permission was last modified",
  "format": "date-time"
}

🔹 Change 14

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: CreateInvite --> CreateInviteMeta --> ApplicationPermission
Schema Action: PROPERTY_ADDED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.__v
New Schema:

{
  "type": "number",
  "description": "Version key used for tracking schema changes in the database."
}

🔹 Change 15

Action: remove
Type: non-breaking
xGroup: N/A
Schema Ref: Role
Schema Action: OPERATION_ID_REMOVED
Path: paths.deleteRole.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5

🔹 Change 16

Action: replace
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.deleteRole.methodTypePlaceHolder.path
New Schema:

"/service/platform/authorization/v1.0/company/{company_id}/role/{role_title}"

🔧 Operation: `getStaffMemberDetails`

🔹 Change 1

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> StoreAccess
Schema Action: ENUM_ADDED
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.store_access.properties.access_type.enum
New Schema:

[
  "company",
  "store"
]

🔹 Change 2

Action: add
Type: breaking
xGroup: N/A
Schema Ref: GetInviteResponseSchema --> Invite --> Meta --> ExtensionAccess
Schema Action: ENUM_ADDED
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.extension_access.properties.access_type.enum
New Schema:

[
  "specific",
  "all"
]

🔹 Change 3

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
New Schema:

"date-time"

🔹 Change 4

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
New Schema:

"date-time"

🔹 Change 5

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.created_at.format
New Schema:

"date-time"

🔹 Change 6

Action: add
Type: breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.modified_at.format
New Schema:

"date-time"

🔹 Change 7

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffDetailsResponseSchema --> ApplicationPermissionResponseSchema
Schema Action: PROPERTY_ADDED
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.company
New Schema:

{
  "type": "integer",
  "description": "ID of the company associated with the permission"
}

🔹 Change 8

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: StaffDetailsResponseSchema --> ApplicationPermissionResponseSchema
Schema Action: PROPERTY_ADDED
Path: paths.getStaffMemberDetails.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.application_permissions.items.properties.super_user
New Schema:

{
  "type": "boolean",
  "description": "wheather the user is a super user or not"
}

🔧 Operation: `removeStaffMember`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: N/A
Path: paths.removeStaffMember.methodTypePlaceHolder.security
New Schema:

[
  {
    "oauth2": [
      "company/staff/write"
    ]
  }
]

🔧 Operation: `removeStaffMembers`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.removeStaffMembers
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Delete a staff members",
    "description": "This is a Staff API for removing an user from company staff",
    "operationId": "removeStaffMembers",
    "x-groups": [
      "Staff"
    ],
    "parameters": [
      {
        "name": "company_id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        }
      },
      {
        "name": "user_id",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66b1b83cbc628d6c64c06d63"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful response",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/StaffDeleteResponseSchema"
            },
            "examples": {
              "success": {
                "value": {
                  "ok": 1,
                  "deleted_count": 0,
                  "n": 0,
                  "application_permissions": [
                    {
                      "ok": 1,
                      "deleted_count": 0,
                      "n": 0
                    },
                    {
                      "ok": 1,
                      "deleted_count": 0,
                      "n": 0
                    }
                  ],
                  "extension_access": {
                    "acknowledged": true,
                    "deleted_count": 0
                  }
                }
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/staff/write"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/staff",
    "methodType": "delete"
  }
}

🔧 Operation: `getStaffCount`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getStaffCount
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Staff Count",
    "description": "Retrieve the count of staff members for a specific company",
    "operationId": "getStaffCount",
    "x-groups": [
      "Staff"
    ],
    "parameters": [
      {
        "name": "company_id",
        "in": "path",
        "required": true,
        "description": "The unique identifier for the company",
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful response with staff count",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CountResult"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/CountResult"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/staff/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/staff/count",
    "methodType": "get"
  }
}

🔧 Operation: `getCurrentUserAccess`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getCurrentUserAccess
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Current User Access",
    "description": "Retrieve the access details of the current user in the specified company",
    "operationId": "getCurrentUserAccess",
    "x-groups": [
      "Staff"
    ],
    "parameters": [
      {
        "name": "company_id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "The unique identifier for the company",
        "examples": {
          "success": {
            "value": "1"
          }
        }
      },
      {
        "name": "app_permissions",
        "in": "query",
        "schema": {
          "type": "boolean"
        },
        "description": "The flag to fetch the app permissions",
        "examples": {
          "success": {
            "value": true
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of user access details",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UserAccess"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/UserAccess"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/staff/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/staff/current/access",
    "methodType": "get"
  }
}

🔧 Operation: `updateUserProfile`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.updateUserProfile
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update User Profile",
    "description": "Update the employee code for the current user in the specified company.",
    "operationId": "updateUserProfile",
    "x-groups": [
      "Staff"
    ],
    "parameters": [
      {
        "name": "company_id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "The unique identifier for the company",
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "requestBody": {
      "description": "The employee code to update for the user.",
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UserProfileUpdate"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/UserProfileUpdate"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful update of user profile.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/StaffUpdate"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/StaffUpdate"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/staff/write"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/staff/user-profile",
    "methodType": "put"
  }
}

🔧 Operation: `getCompanyPermissions`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getCompanyPermissions
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Company Permissions",
    "description": "Retrieve the permissions and roles for the company and applications.",
    "operationId": "getCompanyPermissions",
    "x-groups": [
      "Staff"
    ],
    "parameters": [
      {
        "name": "company_id",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        },
        "description": "The unique identifier for the company"
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of company permissions and roles.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/GetPermissionsResult"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/GetPermissionsResult"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/staff/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/staff/permissions",
    "methodType": "get"
  }
}

🔧 Operation: `getSSOConfiguration`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getSSOConfiguration
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get SSO Configuration",
    "description": "Retrieve the Single Sign-On configuration for the specified company.",
    "operationId": "getSSOConfiguration",
    "x-groups": [
      "SAML"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of SSO configuration.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SSOConfiguration"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/SSOConfiguration"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/saml/sp/config",
    "methodType": "get"
  }
}

🔧 Operation: `getSAMLConfiguration`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getSAMLConfiguration
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get SAML Configuration",
    "description": "Retrieve the SAML configuration for the specified company.",
    "operationId": "getSAMLConfiguration",
    "x-groups": [
      "SAML"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of SAML configuration.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SAMLConfiguration"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/SAMLConfiguration"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/saml/idp/config",
    "methodType": "get"
  }
}

🔧 Operation: `updateSAMLConfiguration`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.updateSAMLConfiguration
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update SAML Configuration",
    "description": "Update the SAML configuration for the specified company.",
    "operationId": "updateSAMLConfiguration",
    "x-groups": [
      "SAML"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "requestBody": {
      "description": "SAML configuration details for the company.",
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SAMLConfiguration"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/SAMLConfiguration"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful update of SAML configuration.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SAMLConfiguration"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/SAMLConfiguration"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/write"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/saml/idp/config",
    "methodType": "post"
  }
}

🔧 Operation: `getSAMLLoginConfiguration`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getSAMLLoginConfiguration
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get SAML Login Configuration",
    "description": "Retrieve the SAML login configuration details for the specified company.",
    "operationId": "getSAMLLoginConfiguration",
    "x-groups": [
      "SAML"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of SAML login configuration.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SAMLLoginConfiguration"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/SAMLLoginConfiguration"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/saml/login/config",
    "methodType": "get"
  }
}

🔧 Operation: `getUserPinRoutes`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getUserPinRoutes
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get User Pin Routes",
    "description": "Retrieve the list of pin routes for a user within a specified company.",
    "operationId": "getUserPinRoutes",
    "x-groups": [
      "User Pins"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      },
      {
        "name": "type",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "default": "pin"
        },
        "description": "The type of routes to retrieve (default is 'pin')"
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of user pin routes.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UserPinList"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/UserPinList"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/user-pin",
    "methodType": "get"
  }
}

🔧 Operation: `updateUserPinRoutes`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.updateUserPinRoutes
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update User Pin Routes",
    "description": "Update or add a new pin route for a user within a specified company",
    "operationId": "updateUserPinRoutes",
    "x-groups": [
      "User Pins"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "requestBody": {
      "description": "Details of the pin route to be updated or added.",
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UserPinRouteUpdate"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/UserPinRouteUpdate"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful update or addition of user pin route.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UserPin"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/UserPin"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/user-pin",
    "methodType": "post"
  }
}

🔧 Operation: `getOAuthClients`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getOAuthClients
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Retrieve a list of OAuth Clients",
    "description": "Fetch a paginated list of OAuth clients for a specific company.",
    "operationId": "getOAuthClients",
    "x-groups": [
      "OAuth Clients"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      },
      {
        "name": "is_active",
        "in": "query",
        "description": "Filter clients by their active status.",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "true",
            "false"
          ]
        },
        "examples": {
          "success": {
            "value": "true"
          }
        }
      },
      {
        "name": "page",
        "in": "query",
        "description": "The page number to retrieve.",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        }
      },
      {
        "name": "limit",
        "in": "query",
        "description": "Number of items per page.",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 10
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of OAuth client details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClientList"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClientList"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/client",
    "methodType": "get"
  }
}

🔧 Operation: `createOAuthClient`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.createOAuthClient
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Create a new OAuth Client",
    "description": "Register a new OAuth client for a specific company.",
    "operationId": "createOAuthClient",
    "x-groups": [
      "OAuth Clients"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      }
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OAuthClient"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/CreateOAuthClient"
            }
          }
        }
      }
    },
    "responses": {
      "201": {
        "description": "Successfully created a new OAuth client.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/client",
    "methodType": "post"
  }
}

🔧 Operation: `getOAuthClient`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.getOAuthClient
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get OAuth Client Details",
    "description": "Retrieve the details of an OAuth client for a specified company",
    "operationId": "getOAuthClient",
    "x-groups": [
      "OAuth Clients"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      },
      {
        "in": "path",
        "name": "client_id",
        "description": "The unique identifier for the OAuth client",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66acb49a1806ef9a7d7c858d"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of OAuth client details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/client/{client_id}",
    "methodType": "get"
  }
}

🔧 Operation: `updateOAuthClient`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.updateOAuthClient
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update OAuth Client",
    "description": "Update the metadata of an OAuth client for a specified company.",
    "operationId": "updateOAuthClient",
    "x-groups": [
      "OAuth Clients"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      },
      {
        "in": "path",
        "name": "client_id",
        "description": "The unique identifier for the OAuth client",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66acb49a1806ef9a7d7c858d"
          }
        }
      }
    ],
    "requestBody": {
      "description": "The metadata to update for the OAuth client.",
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UpdateOAuthClient"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/UpdateOAuthClient"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful update of OAuth client metadata.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/client/{client_id}",
    "methodType": "put"
  }
}

🔧 Operation: `deleteOAuthClient`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.deleteOAuthClient
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Delete OAuth Client",
    "description": "Delete an OAuth client for a specified company.",
    "operationId": "deleteOAuthClient",
    "x-groups": [
      "OAuth Clients"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "description": "The unique identifier for the company",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "1"
          }
        }
      },
      {
        "in": "path",
        "name": "client_id",
        "description": "The unique identifier for the OAuth client",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66acbc86ea5380b5615eb859"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful deletion of OAuth client.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/read"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/client/{client_id}",
    "methodType": "delete"
  }
}

🔧 Operation: `generateOAuthToken`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.generateOAuthToken
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Generate OAuth Token",
    "description": "Generate an OAuth token for a given client using client credentials or other supported grant types.",
    "operationId": "generateOAuthToken",
    "x-groups": [
      "OAuth Tokens"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "required": true,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AccessTokenCreation"
          },
          "examples": {
            "success": {
              "value": {
                "client_id": "66ae252f8a93bd884161a333",
                "client_secret": "abcd1234",
                "grant_type": "client_credentials"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successfully obtained an OAuth token",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AccessTokenDetails"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/TokenExample"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/write"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/token",
    "methodType": "post"
  }
}

🔧 Operation: `generateOAuthStaffToken`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.generateOAuthStaffToken
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Generate OAuth Staff Token",
    "description": "Generate an OAuth token for a staff member with valid session credentials.",
    "operationId": "generateOAuthStaffToken",
    "x-groups": [
      "OAuth Tokens"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "required": true,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "offline token success": {
            "value": 1
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Offline token generated successfully",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AccessTokenDetails"
            },
            "examples": {
              "offline token success": {
                "$ref": "#/components/examples/TokenExample"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/write"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/staff/token",
    "methodType": "get"
  }
}

🔧 Operation: `generateOfflineOAuthToken`

🔹 Change 1

Action: add
Type: non-breaking
xGroup: N/A
Schema Ref: N/A
Schema Action: OPERATION_ID_ADDED
Path: paths.generateOfflineOAuthToken
New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Generate Offline OAuth Token",
    "description": "Generate an offline OAuth token for a client with valid credentials and grant type.",
    "operationId": "generateOfflineOAuthToken",
    "x-groups": [
      "OAuth Tokens"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "company_id",
        "required": true,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        }
      }
    ],
    "requestBody": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OfflineAccessTokenCreation"
          },
          "examples": {
            "success": {
              "value": {
                "client_id": "66ae252f8a93bd884161a32c",
                "client_secret": "abcd1234",
                "grant_type": "client_credentials",
                "code": "auth_code"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Offline token generated successfully",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AccessTokenDetails"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/TokenExample"
              }
            }
          }
        }
      }
    },
    "security": [
      {
        "oauth2": [
          "company/settings/write"
        ]
      }
    ],
    "path": "/service/platform/authorization/v1.0/company/{company_id}/oauth/offline-token",
    "methodType": "post"
  }
}

API Change Log - PLATFORM Module

🧩 Service: Authorization​

🔧 Operation: resendCompanyInvite​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔹 Change 6​

🔹 Change 7​

🔹 Change 8​

🔹 Change 9​

🔹 Change 10​

🔧 Operation: createCompanyInvite​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔹 Change 6​

🔹 Change 7​

🔹 Change 8​

🔹 Change 9​

🔹 Change 10​

🔧 Operation: getCompanyInvite​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔹 Change 6​

🔹 Change 7​

🔹 Change 8​

🔹 Change 9​

🔹 Change 10​

🔧 Operation: deleteCompanyInvite​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔧 Operation: sendCompanyInvite​

🔹 Change 1​

🔹 Change 2​

🔧 Operation: getStaffMembersList​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔹 Change 6​

🔹 Change 7​

🔧 Operation: updateCompanyStaff​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔹 Change 6​

🔹 Change 7​

🔹 Change 8​

🔹 Change 9​

🔹 Change 10​

🔹 Change 11​

🔧 Operation: createRole​

🔹 Change 1​

🔹 Change 2​

🔹 Change 3​

🔹 Change 4​

🔹 Change 5​

🔹 Change 6​

🔹 Change 7​

🔹 Change 8​

🔹 Change 9​

🔹 Change 10​

🔹 Change 11​

🔹 Change 12​

🔹 Change 13​

🔹 Change 14​

🔹 Change 15​

🧩 Service: `Authorization`

🔧 Operation: `resendCompanyInvite`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔹 Change 6

🔹 Change 7

🔹 Change 8

🔹 Change 9

🔹 Change 10

🔧 Operation: `createCompanyInvite`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔹 Change 6

🔹 Change 7

🔹 Change 8

🔹 Change 9

🔹 Change 10

🔧 Operation: `getCompanyInvite`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔹 Change 6

🔹 Change 7

🔹 Change 8

🔹 Change 9

🔹 Change 10

🔧 Operation: `deleteCompanyInvite`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔧 Operation: `sendCompanyInvite`

🔹 Change 1

🔹 Change 2

🔧 Operation: `getStaffMembersList`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔹 Change 6

🔹 Change 7

🔧 Operation: `updateCompanyStaff`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔹 Change 6

🔹 Change 7

🔹 Change 8

🔹 Change 9

🔹 Change 10

🔹 Change 11

🔧 Operation: `createRole`

🔹 Change 1

🔹 Change 2

🔹 Change 3

🔹 Change 4

🔹 Change 5

🔹 Change 6

🔹 Change 7

🔹 Change 8

🔹 Change 9

🔹 Change 10

🔹 Change 11

🔹 Change 12

🔹 Change 13

🔹 Change 14

🔹 Change 15

🔹 Change 16