Skip to content

docs(profiles): add FieldIdentifier applicability table per profile #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aorzelskiGH wants to merge 1 commit into
base: IDTA-01002-3-2_working
Choose a base branch
from
Open

docs(profiles): add FieldIdentifier applicability table per profile #584

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions ...002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,30 @@
Note: in the following, only the last part (<name of service specification>/SSP-<profile number>) is used in the text for better readability, e.g. “AssetAdministrationShellServiceSpecification/SSP-001” instead of “https://admin-shell.io/aas/API/3/2/AssetAdministrationShellServiceSpecification/SSP-001”.
====

[#fieldidentifier-applicability]
=== FieldIdentifier Applicability per Profile

The AAS Query Language (see xref:query-language.adoc[]) and the Security Access Rule Model (see the Security specification, IDTA-01004) use a set of FieldIdentifier prefixes (`$aas`, `$sm`, `$sme`, `$cd`, `$aasdesc`, `$smdesc`). Not every prefix is meaningful in every profile, because the underlying data is only exposed by specific service specifications.

Check warning on line 82 in documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'IDTA'

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'IDTA'

The following table summarises which FieldIdentifier prefix is applicable per service specification family:

[cols="3,1,1,1,1,1,1",options="header"]
|===
| Service Specification (family) | $aas | $sm | $sme | $cd | $aasdesc | $smdesc

Check warning on line 88 in documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'smdesc'

Check warning on line 88 in documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'aasdesc'

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'aasdesc'

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'smdesc'
| AssetAdministrationShellRepositoryServiceSpecification | ✓ | ✓ | ✓ | — | — | —
| SubmodelRepositoryServiceSpecification | — | ✓ | ✓ | — | — | —
| ConceptDescriptionRepositoryServiceSpecification | — | — | — | ✓ | — | —
| AssetAdministrationShellRegistryServiceSpecification | — | — | — | — | ✓ | ✓
| SubmodelRegistryServiceSpecification | — | — | — | — | — | ✓
| AssetAdministrationShellServiceSpecification | ✓ | ✓ | ✓ | — | — | —
| SubmodelServiceSpecification | — | ✓ | ✓ | — | — | —
| DiscoveryServiceSpecification | — | — | — | — | — | —
|===

Queries and access rules that reference a prefix marked with "—" for the chosen profile are treated as *not applicable* in that profile: they MUST NOT cause a parse or evaluation error, they simply do not match any object in the deployment. Implementations SHOULD clearly indicate in their deployment documentation which profiles they expose so that operators can scope their rules accordingly.

This table is referenced by IDTA-01004 § "Descriptor FieldIdentifier Applicability".

Check warning on line 101 in documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/service-specifications-and-profiles.adoc

View workflow job for this annotation

GitHub Actions / qodana

Typo 

Typo: In word 'IDTA'

Check warning

Code scanning / QDJVMC

Typo Warning documentation

Typo: In word 'IDTA'

[#asset-administration-shell-service-specification]
== Asset Administration Shell Service Specification

Expand Down
Loading