Skip to content

docs(annex): add normative Operation-to-RIGHT mapping#586

Open
aorzelskiGH wants to merge 1 commit intoIDTA-01002-3-2_workingfrom
docs/operation-to-right-mapping
Open

docs(annex): add normative Operation-to-RIGHT mapping#586
aorzelskiGH wants to merge 1 commit intoIDTA-01002-3-2_workingfrom
docs/operation-to-right-mapping

Conversation

@aorzelskiGH
Copy link
Copy Markdown
Contributor

Summary

Add a normative annex "Operation to RIGHT Mapping" that binds every AAS HTTP/REST API operation to a RIGHT value from IDTA-01004's rightsEnum, together with a compatible ROUTE literal example.

Problem

IDTA-01004 provides an indicative mapping from RIGHTS to HTTP methods, but the per-operation mapping (operationId -> RIGHT) is not defined in either spec. Enforcement points therefore make inconsistent choices, in particular for:

  • PUT on client-addressable resources (CREATE vs. UPDATE),
  • VIEW vs. READ on registry resources,
  • EXECUTE on operation invocation endpoints,
  • attachment endpoints (GetFileByPath, PutFileByPath, DeleteFileByPath).

Solution

Add pages/annex/operation-to-right-mapping.adoc with a normative table covering Shell, Submodel, SubmodelElement, attachment, ConceptDescription, Descriptor (AAS / Submodel Registry), Discovery, Description and Query operations. Register the annex in nav.adoc.

Affected files

  • documentation/IDTA-01002-3/modules/ROOT/pages/annex/operation-to-right-mapping.adoc (new)
  • documentation/IDTA-01002-3/modules/ROOT/nav.adoc

Review notes

  • Paired Security PR admin-shell-io/aas-specs-security#... references this annex from the Rights-and-operation-verbs section.
  • Please verify the table against the latest OpenAPI documents; any operation added in future PRs MUST append a row here.
  • "CREATE or UPDATE" entries are deliberate: the enforcement point resolves the right at request time.

Refs: Review Finding T-10

Add a new annex that defines, for every AAS HTTP/REST API operation,
the RIGHT (per IDTA-01004 rightsEnum) an access-rule enforcement
point MUST use. The table covers:

- AAS Repository and AAS Service operations (shells, submodels,
  submodel elements, attachments, operation invocation),
- Concept Description Repository operations,
- Registry operations (shell- and submodel-descriptors),
- Discovery operations (/lookup/shells),
- /description and /query.

For PUT on client-addressable resources, the required RIGHT is
listed as "CREATE or UPDATE" and the enforcement point resolves
the right at request time based on existence.

Also register the new annex in nav.adoc.

Refs: Review Finding T-10
Made-with: Cursor
Copy link
Copy Markdown

@github-advanced-security github-advanced-security AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QDJVMC found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants