Skip to content

Add Note for Metadata and ValueOnly Representations of Asset Administration Shells #426

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

Merged
BirgitBoss merged 1 commit into from
Mar 24, 2025
Merged

Add Note for Metadata and ValueOnly Representations of Asset Administration Shells #426

Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions documentation/IDTA-01002-3/modules/ROOT/pages/changelog.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Minor Changes:
* Clarification on how to handle duplicate query parameters
* Replace "servers" clause in OpenAPI files
* Add notes for base64url-encoded values and order of "assetIds" query parameters
* xref:http-rest-api/http-rest-api.adoc#modifier-constraints[HTTP Modifier Constraints]: Adding note for metadata and value-only representations of Asset Administration Shells (https://github.com/admin-shell-io/aas-specs-api/issues/268[#268])

=== Interface Changes w.r.t. V3.0.3 to V3.1

Expand Down
6 changes: 5 additions & 1 deletion documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ Additional classes needed for payload of the HTTP/REST API specification can be
[#modifier-constraints]
== Modifier Constraints

// Previously pointing to Clause 12.5

To use link:https://admin-shell-io.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html#_format_metadata_metadata_serialization[metadata objects] as described in xref:bibliography.adoc#bib1[[1]]., modifiers are implemented as HTTP query parameters or path suffixes.
For example, a request for a specific submodel may look like: +
GET /submodel/$value?level=deep&extent=withBlobValue
Expand All @@ -350,6 +350,10 @@ In addition, the modifiers can also be used for PUT operations.
They define how the request content is delivered and have the same semantics as in the related GET operation.
Only Content=Reference and Content=Path are not possible for PUT.

====
Note: Although metadata and value-only representations of Asset Administration Shells are possible, they are not supported up to now.
====

== Mapping of Operations

The following <<table-mapping-operations>> shows the mapping of the generic operations to the HTTP/REST API.
Expand Down
Loading