Skip to content

Commit dcc8d2c

Browse files
authored
Move documentation of unimplemented routes (#440)
This moves the documentation of unimplemented routes of the server from the module docstring to the project `README.md`. Fixes #380
1 parent 4bd142a commit dcc8d2c

File tree

2 files changed

+28
-26
lines changed

2 files changed

+28
-26
lines changed

server/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,34 @@ The server can also be run directly on the host system without Docker, NGINX and
126126

127127
The server can be accessed at http://localhost:8080/api/v3.0/ from your host system.
128128

129+
## Currently Unimplemented
130+
Several features and routes are currently not supported:
131+
132+
1. Correlation ID: Not implemented because it was deemed unnecessary for this server.
133+
134+
2. Extent Parameter (`withBlobValue/withoutBlobValue`):
135+
Not implemented due to the lack of support in JSON/XML serialization.
136+
137+
3. Route `/shells/{aasIdentifier}/asset-information/thumbnail`: Not implemented because the specification lacks clarity.
138+
139+
4. Serialization and Description Routes:
140+
- `/serialization`
141+
- `/description`
142+
These routes are not implemented at this time.
143+
144+
5. Value, Path, and PATCH Routes:
145+
- All `/…/value$`, `/…/path$`, and `PATCH` routes are currently not implemented.
146+
147+
6. Operation Invocation Routes: The following routes are not implemented because operation invocation
148+
is not yet supported by the `basyx-python-sdk`:
149+
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke`
150+
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value`
151+
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async`
152+
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value`
153+
- `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-status/{handleId}`
154+
- `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}`
155+
- `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value`
156+
129157
## Acknowledgments
130158

131159
This Dockerfile is inspired by the [tiangolo/uwsgi-nginx-docker][10] repository.

server/app/interfaces/repository.py

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,6 @@
66
# SPDX-License-Identifier: MIT
77
"""
88
This module implements the "Specification of the Asset Administration Shell Part 2 Application Programming Interfaces".
9-
However, several features and routes are currently not supported:
10-
11-
1. Correlation ID: Not implemented because it was deemed unnecessary for this server.
12-
13-
2. Extent Parameter (`withBlobValue/withoutBlobValue`):
14-
Not implemented due to the lack of support in JSON/XML serialization.
15-
16-
3. Route `/shells/{aasIdentifier}/asset-information/thumbnail`: Not implemented because the specification lacks clarity.
17-
18-
4. Serialization and Description Routes:
19-
- `/serialization`
20-
- `/description`
21-
These routes are not implemented at this time.
22-
23-
5. Value, Path, and PATCH Routes:
24-
- All `/…/value$`, `/…/path$`, and `PATCH` routes are currently not implemented.
25-
26-
6. Operation Invocation Routes: The following routes are not implemented because operation invocation
27-
is not yet supported by the `basyx-python-sdk`:
28-
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke`
29-
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value`
30-
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async`
31-
- `POST /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value`
32-
- `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-status/{handleId}`
33-
- `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}`
34-
- `GET /submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value`
359
"""
3610

3711
import io

0 commit comments

Comments
 (0)