DotAAS Part 2: HTTP API #238

list werkzeug as a dependency in the readme

adapter.http: add custom identifier converter for werkzeug adapter.http: restructure routing map, add first submodel route adapter.http: refine imports

adapter._generic: add identifier URI encode/decode functions adapter.http: make api routes return ResponseData instead of the Response directly adapter.http: add Result + Message types + factory function

adapter.http: add request body parsing adapter.http: implement all remaining aas routes

- use stripped object serialization/deserialization - change response format (new spec always returns a result object)

adapter.http: remove old routes, add a few new aas and submodel routes

…ntifiers

using the werkzeug.routing.MapAdapter url builder

Requests to URIs with a trailing slash will now be redirected to the respective URI without trailing slash. e.g. GET /aas/$identifier/ -> GET /aas/$identifier A redirect will only be set if the respective URI without trailing slash exists and the current request method is valid for the new URI. Historically, the trailing slash was only present when the requested resource was a directory. In our case the resources don't work like directories, in the sense, that each resource doesn't even list possible subsequent resources. So because our resources don't behave like directories, they shouldn't have a trailing slash.

for better error messages

because that's default anyways

to stay consistent with the rest of this library

add IdShortPathConverter and helper functions

change type check from `not A is B` to `A is not B` for better readability

… attributes like statement, annotation and value

…ableEntity

add initial specification discussed in the meeting (03.09.2020)

…d object

update json schema make routes more consistent

remove default responses smaller fixes

add link to git repo of the PyI40AAS framework

…description

…eader

… is a BadRequest (400)

…nested route

…pe) in PUT/PATCH routes

improve filename use .yaml instead of .yml file extension (see https://yaml.org/faq.html)

http-api-oas: follow suit

…type

requirements.txt: add hypothesis and schemathesis .gitignore: add /.hypothesis/ directory

... in accordance to 0e343ac.

update response encoders update response data

because the view routes have been removed

…est body add aas/submodel repository interface

…t_body() call

add Base64UrlJsonConverter for json objects encoded as base64url as part of the url support deserializing submodels in HTTPApiDecoder add POST routes, remove 'create' functionality from PUT routes

This commit consists mostly of renamed variables, but also other stuff like the identifiers, which consisted of an IdentifierType and the actual Identifier previously.

Views were removed from the spec and we're no longer using `example_aas_missing_attributes()` anyway.

The submount has been removed from the spec, yay!

adapter.http: remove `/aas` submount from AAS repository

adapter.http: update base URL from `/api/v1` to `/api/v3.0`

…rter_error_messages adapter.http: remove hardcoded encoding from error messages

merge `main` in `feature/http_api`

Many online tools omit the padding when encoding base64url. Thus, requesters may omit the padding as well, which would cause the decoding to fail. Thus, we simply always append two padding characters, because python doesn't complain about too much padding.

... by using (now) builtin functionality.

The http adapter still used the old `construct_aas_reference` function, which doesn't exist anymore. The error was masked due to a broad `type: ignore`. These are changed to only ignore assignment type errors.

We can always call `_get_submodel_or_nested_submodel_element`, as it returns the submodel itself if we don't pass it any id_shorts.

... instead of the previous way of creating a `MultiLanguageProperty` to validate id_shorts.

adapter.http: fix base64 decoding without padding

adapter.http: remove `/submodel` submount from Submodel repository

…th_resolution adapter.http: use builtin id_short path resolution

…e_deserialization adapter.http: fix `ModelReference` json deserialization

adapter.http: simplify XML serialization

…nt_deletion adapter.http: simplify `SubmodelElement` deletion

…ation adapter.http: simplify `id_short` validation

adapter.http: implement submodel repo routes

The route now uses the submodel identifier instead of the submodel reference.

adapter.http: change `base64url_encode()` function to return `str`

…s_routes adapter.http: update AAS submodel refs path and `DELETE` route

adapter.http: suffix slashes to all routes

The submodel routes of the AAS API `/shells/<aas_id>/submodels` are the same already implemented as the submodel API, so we return a redirect here, after checking that the AAS indeed has a reference to the requested submodel. `PUT` and `DELETE` are different, as we also have to update the AAS in this case, either by adding a new updated reference in case of a `PUT` request changes the submodel id, or by removing the submodel reference for `DELETE` requests.

adapter.http: implement AAS API submodel routes via redirects

…routes_to_submount adapter.http: move `asset-information` routes to a submount

adapter.http: fix qualifier routes

The `IdentifierConverter` is also used to decode values from URLs, that aren't necessarily Identifiers, e.g. Qualifier types. Thus, a name like `Base64URLConverter` suits its use better and is also more expressive. For the same reasons, the key `identifier`, which was used for the `IdentifierConverter`, is renamed to `base64url`.

adapter.http: rename `IdentifierConverter` to `Base64URLConverter`

Methods `_get_shell()` and `_get_shells()` are added similarly to `_get_submodel()` and `_get_submodels()`, which were previously added in ffb833b. Furthermore, when requesting multiple AAS/Submodels, we're now also updating these in `_get_all_obj_of_type()` before returning them. Finally, updating AAS/Submodel objects is also moved to `_get_obj_ts()`.

adapter.http: refactor AAS retrieval

adapter.http: remove outdated TODOs

* adapter.http: implement the attachment routes * adapter.http: fix codestyle errors * adapter.http: implement recommended changes * adapter.http: implement new recommended changes

…dk into http_api/implement_AAS_reference_routes

…_routes adapter.http: implement the AAS reference routes

adapter.http: implement the pagination

adapter.http: implement warning for not implemented routes

adapter.http: remove excess blank line

merge `main` in `feature/http_api`

`AbstractSupplementaryFileContainer` and `DictSupplementaryFileContainer` are extended by a `delete_file()` method, that allows deleting files from them. Since different files may have the same content, references to the files contents in `DictSupplementaryFileContainer._store` are tracked via `_store_refcount`. A files contents are only deleted from `_store`, if all filenames referring to these these contents are deleted, i.e. if the refcount reaches 0.

DeprecationWarning: datetime.datetime.utcnow() is deprecated and scheduled for removal in a future version. Use timezone-aware objects to represent datetimes in UTC: datetime.datetime.now(datetime.UTC)

This change makes use of the `SupplementaryFileContainer` interface of the AASX adapter. It allows the API to operate seamlessly on AASX files, including the contained supplementary files, without having to access the filesystem. Furthermore, the support for the modification of `Blob` values is removed (the spec prohibits it).

…n_warning adapter.http: fix a `DeprecationWarning`

adapter.http: allow retrieving and modifying `File` attachments via API

adapter.http: allow changing the API base path

This check was intended to return 501 instead of 404 for routes that haven't been implemented. However, we explicitly implement these routes to return 501 now anyway, returning 501 for all other paths would be semantically incorrect anyway and the check never worked.

Merge/main in feature http api

Werkzeug 3.0.3 contains a fix for [1], so by requiring at least 3.0.3, we can remove unnecessary 'type: ignore' comments from the http adapter. [1]: pallets/werkzeug#2836

Remove 'type: ignore' comments now that we require werkzeug >=3.0.3 [1]. Furthermore, fix the type hint of `WSGIApp._get_slice()` and make two other 'type: ignore' comments more explicit. [1]: pallets/werkzeug#2836

adapter.http: remove and improve `type: ignore` comments

…t_implemented_check

…t_implemented_check adapter.http: remove nonfunctional 'Not Implemented' check

This removes trailing slashes (and redirects to paths with trailing slashes) from the API and makes it compatible with the PCF2 showcase and other webapps. Previously, all routes were implemented with a trailing slash, e.g. `/submodels/` instead of `/submodels`. While the API spec only specifies the routes without a trailing slash, this has the advantage of being compatible with requests to the path with a trailing slash and without trailing slash, as werkzeug redirects requests to the slash-terminated path, if available. However, this poses a problem with browsers that make use of [CORS preflight requests][1] (e.g. Chromium-based browsers). Here, before doing an actual API request, the browser sends an `OPTIONS` request to the path it wants to request. This is done to check potential CORS headers (e.g. `Access-Control-Allow-Origin`) for the path, without retrieving the actual data. Our implementation doesn't support `OPTIONS` requests, which is fine. After the browser has received the response to the preflight request (which may or may not have been successful), it attempts to retrieve the actual data by sending the request again with the correct request method (e.g. `GET`). With our server this request now results in a redirect, as we redirect to the path with a trailing slash appended. This is a problem, as the browser didn't send a CORS preflight request to the path it is now redirected to. It also doesn't attempt to send another CORS preflight request, as it already sent one, with the difference being the now slash-terminated path. Thus, following the redirect is prevented by CORS policy and the data fails to load. By making the routes available via non-slash-terminated paths we avoid the need for redirects, which makes the server compatible with webapps viewed in browsers that use preflight requests. Requests to slash-terminated paths will no longer work (they won't redirect to the path without trailing slash). This shouldn't be a problem though, as the API is only specified without trailing slashes anyway.

adapter.http: remove unnecessary generator expression

adapter.http: remove trailing slashes from routes

This adds a module docstring to `adapter.http`, that details which features from the Specification of the Asset Administration Shell Part 2 (API) were not implemented.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DotAAS Part 2: HTTP API #238

DotAAS Part 2: HTTP API #238

Commits on Feb 14, 2024

Commits on Feb 15, 2024

Commits on Feb 21, 2024

Commits on Mar 6, 2024

Commits on Mar 15, 2024

Commits on Mar 16, 2024

Commits on Mar 17, 2024

Commits on Mar 18, 2024

Commits on Mar 20, 2024

Commits on Mar 27, 2024

Commits on Mar 28, 2024

Commits on Mar 29, 2024

Commits on Mar 31, 2024

Commits on Apr 3, 2024

Commits on Apr 5, 2024

Commits on Apr 19, 2024

Commits on Apr 23, 2024

Commits on Apr 28, 2024

Commits on Apr 30, 2024

Commits on May 9, 2024

Commits on May 14, 2024

Commits on May 23, 2024

Commits on May 24, 2024

Commits on Jun 7, 2024

Commits on Jun 13, 2024

Commits on Jun 15, 2024

Commits on Jun 19, 2024

Commits on Jun 20, 2024

Commits on Jul 19, 2024

Commits on Jul 22, 2024

Commits on Aug 15, 2024