adapter.http: add documentation of not implemented features (#52)

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.

basyx/aas/adapter/http.py

@@ -4,6 +4,35 @@
 # the LICENSE file of this project.
 #
 # SPDX-License-Identifier: MIT
+"""
+This module implements the "Specification of the Asset Administration Shell Part 2 Application Programming Interfaces".
+However, several features and routes are currently not supported:
+
+1. Correlation ID: Not implemented because it was deemed unnecessary for this server.
+
+2. Extent Parameter (`withBlobValue/withoutBlobValue`):
+ Not implemented due to the lack of support in JSON/XML serialization.
+
+3. Route `/shells/{aasIdentifier}/asset-information/thumbnail`: Not implemented because the specification lacks clarity.
+
+4. Serialization and Description Routes:
+ - `/serialization`
+ - `/description`
+ These routes are not implemented at this time.
+
+5. Value, Path, and PATCH Routes:
+ - All `/…/value$`, `/…/path$`, and `PATCH` routes are currently not implemented.
+
+6. Operation Invocation Routes: The following routes are not implemented because operation invocation
+ is not yet supported by the `basyx-python-sdk`:
+ - `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke`
+ - `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value`
+ - `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async`
+ - `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value`
+ - `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-status/{handleId}`
+ - `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}`
+ - `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value`
+"""
 
 import abc
 import base64