Skip to content

Commit ca11798

Browse files
committed
update README, API is version 3.1.1
1 parent 01f04a4 commit ca11798

3 files changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ These are the currently implemented specifications:
88

99
| Specification | Version |
1010
|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
11-
| Part 1: Metamodel | [v3.0.1 (01001-3-0-1)](https://industrialdigitaltwin.org/wp-content/uploads/2024/06/IDTA-01001-3-0-1_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf) |
11+
| Part 1: Metamodel | [v3.0.1 (01001-3-0-1)](https://industrialdigitaltwin.org/wp-content/uploads/2024/06/IDTA-01001-3-0-1_SpecificationAssetAdministrationShell_Part1_Metamodel.pdf) |
1212
| Schemata (JSONSchema, XSD) | [v3.0.8 (IDTA-01001-3-0-1_schemasV3.0.8)](https://github.com/admin-shell-io/aas-specs/releases/tag/IDTA-01001-3-0-1_schemasV3.0.8) |
13-
| Part 2: API | [v3.0 (01002-3-0)](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2023/06/IDTA-01002-3-0_SpecificationAssetAdministrationShell_Part2_API_.pdf) |
13+
| Part 2: API | [v3.1.1 (01002-3-1-1)](https://industrialdigitaltwin.org/en/wp-content/uploads/sites/2/2025/08/IDTA-01002-3-1-1_AAS-Specification_Part2_API.pdf) |
1414
| Part 3a: Data Specification IEC 61360 | [v3.0 (01003-a-3-0)](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01003-a-3-0_SpecificationAssetAdministrationShell_Part3a_DataSpecification_IEC61360.pdf) |
1515
| Part 5: Package File Format (AASX) | [v3.0 (01005-3-0)](https://industrialdigitaltwin.org/wp-content/uploads/2023/04/IDTA-01005-3-0_SpecificationAssetAdministrationShell_Part5_AASXPackageFileFormat.pdf) |
1616

server/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ To expose it on the host on port 8080, use the option `-p 8080:80` when running
4040

4141
The container can be configured via environment variables:
4242
- `API_BASE_PATH` determines the base path under which all other API paths are made available.
43-
Default: `/api/v3.0`
43+
Default: `/api/v3.1`
4444
- `STORAGE_TYPE` can be one of `LOCAL_FILE_READ_ONLY` or `LOCAL_FILE_BACKEND`:
4545
- When set to `LOCAL_FILE_READ_ONLY` (the default), the server will read and serve AASX, JSON, XML files from the storage directory.
4646
The files are not modified, all changes done via the API are only stored in memory.
@@ -60,7 +60,7 @@ Since Windows uses backslashes instead of forward slashes in paths, you'll have
6060
> docker run -p 8080:80 -v .\storage:/storage basyx-python-server
6161
```
6262

63-
Per default, the server will use the `LOCAL_FILE_READ_ONLY` storage type and serve the API under `/api/v3.0` and read files from `/storage`. If you want to change this, you can do so like this:
63+
Per default, the server will use the `LOCAL_FILE_READ_ONLY` storage type and serve the API under `/api/v3.1` and read files from `/storage`. If you want to change this, you can do so like this:
6464
```
6565
$ docker run -p 8080:80 -v ./storage2:/storage2 -e API_BASE_PATH=/api/v3.1 -e STORAGE_TYPE=LOCAL_FILE_BACKEND -e STORAGE_PATH=/storage2 basyx-python-server
6666
```
@@ -85,7 +85,7 @@ services:
8585
- ./storage:/storage
8686
```
8787
88-
Here files are read from `/storage` and the server can be accessed at http://localhost:8080/api/v3.0/ from your host system.
88+
Here files are read from `/storage` and the server can be accessed at http://localhost:8080/api/v3.1/ from your host system.
8989
To get a different setup this compose.yaml file can be adapted and expanded.
9090

9191
Note that the `Dockerfile` has to be specified explicitly, as the build context must be set to the parent directory of `/server` to allow access to the local `/sdk`.
@@ -108,7 +108,7 @@ The server can also be run directly on the host system without Docker, NGINX and
108108
$ python -m interfaces.repository
109109
```
110110

111-
The server can be accessed at http://localhost:8080/api/v3.0/ from your host system.
111+
The server can be accessed at http://localhost:8080/api/v3.1/ from your host system.
112112

113113
## Acknowledgments
114114

@@ -117,8 +117,8 @@ This Dockerfile is inspired by the [tiangolo/uwsgi-nginx-docker][10] repository.
117117
[1]: https://github.com/eclipse-basyx/basyx-python-sdk/pull/238
118118
[2]: https://basyx-python-sdk.readthedocs.io/en/latest/backend/local_file.html
119119
[3]: https://github.com/eclipse-basyx/basyx-python-sdk
120-
[4]: https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.0.1_SSP-001
121-
[5]: https://app.swaggerhub.com/apis/Plattform_i40/SubmodelRepositoryServiceSpecification/V3.0.1_SSP-001
120+
[4]: https://app.swaggerhub.com/apis/Plattform_i40/AssetAdministrationShellRepositoryServiceSpecification/V3.1.1_SSP-001
121+
[5]: https://app.swaggerhub.com/apis/Plattform_i40/SubmodelRepositoryServiceSpecification/V3.1.1_SSP-001
122122
[6]: https://industrialdigitaltwin.org/content-hub/aasspecifications/idta_01002-3-0_application_programming_interfaces
123123
[7]: https://basyx-python-sdk.readthedocs.io/en/latest/adapter/aasx.html#adapter-aasx
124124
[8]: https://basyx-python-sdk.readthedocs.io/en/latest/adapter/json.html

server/app/interfaces/repository.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959

6060
class WSGIApp(ObjectStoreWSGIApp):
6161
def __init__(self, object_store: model.AbstractObjectStore, file_store: aasx.AbstractSupplementaryFileContainer,
62-
base_path: str = "/api/v3.0"):
62+
base_path: str = "/api/v3.1"):
6363
self.object_store: model.AbstractObjectStore = object_store
6464
self.file_store: aasx.AbstractSupplementaryFileContainer = file_store
6565
self.url_map = werkzeug.routing.Map([

0 commit comments

Comments
 (0)