Skip to content

Extend the Explanation how to discover Endpoints #443

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
merged 1 commit into from
Apr 23, 2025
Merged

Extend the Explanation how to discover Endpoints #443

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 @@ -49,6 +49,7 @@ Minor Changes:
* add xref:annex/overview-constraints.adoc[overview of constraints] to Annex
* xref:http-rest-api/http-rest-api.adoc#design-decisions[Design Decisions for the HTTP API]: Clarify that padding is not allowed for base64url-encoded values (https://github.com/admin-shell-io/aas-specs-api/issues/423[#423])
* 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])
* xref:http-rest-api/interactions.adoc[Interactions]: extending the explanation how to discover endpoints of AAS services

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

Expand Down
4 changes: 3 additions & 1 deletion documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/interactions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ Constraints and assumptions for calling an AAS and a submodel operation by a cli

* The calling application has to be aware that endpoints may change at any time.
If the application has cached an endpoint that is no longer vivid, the application needs to start the interaction to resolve the appropriate endpoint again from the beginning.
* Endpoints for infrastructure interfaces like AAS registries are known at design time of the client application or configured manually before start-up.
* Several ways are possible to get to know the endpoints for the infrastructure interfaces of AAS Discovery and/or Registries before calling the APIs. Some examples:
- A discovery service for dataspace connectors as well as endpoints for AAS services can be found as part of the registered applications on a connector, as e.g. specified in the Catena-X dataspace.
- The endpoints can be configured in the application during start or dynamically at runtime by a user.
* The asset IDs (either the global asset ID or some specific asset IDs) are known to the calling application.
* Access to any API is allowed only if the caller is authenticated.
* Response to any API call takes access rules as defined for the services into account, e.g. access rules for the AASs, the Submodels, or SubmodelElements within a Submodel.
Expand Down
Loading