3
0
Files
corteza/compose/service/module_actions.yaml
Denis Arh 20757e58fa Disallow use of reserved names for module fields
List of reserved names:
 - recordID
 - ownedBy
 - createdBy
 - createdAt
 - updatedBy
 - updatedAt
 - deletedBy
 - deletedAt
2021-10-21 13:20:50 +02:00

119 lines
3.0 KiB
YAML

# List of loggable service actions
resource: compose:module
service: module
# Default sensitivity for actions
defaultActionSeverity: notice
# default severity for errors
defaultErrorSeverity: error
import:
- github.com/cortezaproject/corteza-server/compose/types
props:
- name: module
type: "*types.Module"
fields: [ name, handle, ID, namespaceID ]
- name: changed
type: "*types.Module"
fields: [ name, handle, ID, namespaceID, meta, fields ]
- name: filter
type: "*types.ModuleFilter"
fields: [ query, name, handle, name, namespaceID, sort, limit ]
- name: namespace
type: "*types.Namespace"
fields: [ name, slug, ID ]
actions:
- action: search
log: "searched for modules"
severity: info
- action: lookup
log: "looked-up for a {{module}}"
severity: info
- action: create
log: "created {{module}}"
- action: update
log: "updated {{module}}"
- action: delete
log: "deleted {{module}}"
- action: undelete
log: "undeleted {{module}}"
errors:
- error: notFound
message: "module does not exist"
severity: warning
- error: namespaceNotFound
message: "namespace does not exist"
severity: warning
- error: invalidID
message: "invalid ID"
severity: warning
- error: invalidHandle
message: "invalid handle"
severity: warning
- error: handleNotUnique
message: "handle not unique"
log: "used duplicate handle ({{module.handle}}) for module"
severity: warning
- error: nameNotUnique
message: "name not unique"
log: "used duplicate name ({{module.name}}) for module"
severity: warning
- error: fieldNameReserved
message: "field name is reserved for system fields"
- error: staleData
message: "stale data"
severity: warning
- error: invalidNamespaceID
message: "invalid or missing namespace ID"
severity: warning
- error: notAllowedToRead
message: "not allowed to read this module"
log: "could not read {{module}}; insufficient permissions"
- error: notAllowedToSearch
message: "not allowed to search or list modules"
log: "could not search or list modules; insufficient permissions"
- error: notAllowedToReadNamespace
message: "not allowed to read this namespace"
log: "could not read namespace {{namespace}}; insufficient permissions"
- error: notAllowedToListModules
message: "not allowed to list modules"
log: "could not list modules; insufficient permissions"
- error: notAllowedToCreate
message: "not allowed to create modules"
log: "could not create modules; insufficient permissions"
- error: notAllowedToUpdate
message: "not allowed to update this module"
log: "could not update {{module}}; insufficient permissions"
- error: notAllowedToDelete
message: "not allowed to delete this module"
log: "could not delete {{module}}; insufficient permissions"
- error: notAllowedToUndelete
message: "not allowed to undelete this module"
log: "could not undelete {{module}}; insufficient permissions"