architecture-as-code icon indicating copy to clipboard operation
architecture-as-code copied to clipboard

Include Allowed Operations on Interface

Open Adwoa-Konadu-Appiah opened this issue 9 months ago • 3 comments

Description of Problem: There is no way to describe allowed operations between two nodes on an interface Example: Read, Write

Potential Solutions: We are proposing adding a read/write operation to interfaces to allow users to specify the operation that can be performed on a node using an interface.

The intent of the allowed operations is to show whether a read or write operation is possible on an interface. Not to be conflated with roles or permissions.

"allowed-operations-interface": {
      "$ref": "#/defs/interface-type",
      "type": "object",
      "properties": {
        "operation": "array",
        "items": {
          "$refs": "#/defs/read-write-operation"
        },
        "uniqueItems": true,
        "minItems": 0,
        "maxItems": 2
      },
      "required": [
        "operation"
      ]
  },
  "read-write-operation": {
    "enum": [
      "read",
      "write"
    ]
  }

Adwoa-Konadu-Appiah avatar Mar 19 '25 18:03 Adwoa-Konadu-Appiah

Clarify the intent . . . is this about what a particular actor / persona can do (i.e. entitlements) or simply what operations are available, regardless of whether anyone has the entitlement to execute.

rocketstack-matt avatar Mar 20 '25 15:03 rocketstack-matt

Clarify the intent . . . is this about what a particular actor / persona can do (i.e. entitlements) or simply what operations are available, regardless of whether anyone has the entitlement to execute.

The issue description has been updated to reflect the intent of the allowed operations, i.e. read or write operations on an interface without being associated with roles or permissions. @rocketstack-matt PR is ready to be reviewd.

Adwoa-Konadu-Appiah avatar Mar 21 '25 10:03 Adwoa-Konadu-Appiah

See comment in https://github.com/finos/architecture-as-code/issues/1083

rocketstack-matt avatar Apr 17 '25 15:04 rocketstack-matt

We don't plan to centrally publish standards at this time, individual orgs will host their own.

rocketstack-matt avatar Sep 25 '25 15:09 rocketstack-matt