diff --git a/tsm-api/README.md b/tsm-api/README.md index 12dfdab..3afedcb 100644 --- a/tsm-api/README.md +++ b/tsm-api/README.md @@ -67,9 +67,9 @@ This project is a Maven Java project and is structured as follows: |**Folder**|**Description**| |:----------|:----------| |[dist/](dist/)|Contains resulting build artifacts of the project in several versions.| -|[javadocs/](javadocs/)|Generated when building the project. It contains the extracted JavaDoc HTML documentation of the TSM-API.| -|[src/main/java](src/main/java/)|Contains Java source code files of the TSM-API.| -|[target/](target/)|Generated when building the project. It contains temporary build files created by Maven.| +|javadocs/|Generated when building the project. It contains the extracted JavaDoc HTML documentation of the TSM-API.| +|[src/main/java/](src/main/java/)|Contains Java source code files of the TSM-API.| +|target/|Generated when building the project. It contains temporary build files created by Maven.| @@ -115,7 +115,7 @@ For all processes, the smartphone app needs no direct connection to the vendor o ### 3.4 API Method Overview -The interface [ITsmApiService](javadocs/de/bsi/tsms/tsmapi/ITsmApiService.html) is the main entry point to use the tsm-api.jar. It contains all methods to install, update and uninstall JavaCard applets and apart from that, it offers some additional supporting operations. The following table lists all methods of the TSM-API: +The interface [ITsmApiService](src/main/java/de/bsi/tsms/tsmapi/ITsmApiService.java) is the main entry point to use the tsm-api.jar. It contains all methods to install, update and uninstall JavaCard applets and apart from that, it offers some additional supporting operations. The following table lists all methods of the TSM-API: | *Method* | *Description* | |:------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/tsm-rest-api/README.md b/tsm-rest-api/README.md index 5d78bf2..55a0db6 100644 --- a/tsm-rest-api/README.md +++ b/tsm-rest-api/README.md @@ -4,7 +4,7 @@ The module **tsm-rest-api** is an OpenApi realization of the TSM-Backend REST-API specified in section 4.1 of [BSI-TR-03165](https://www.bsi.bund.de/DE/Themen/Unternehmen-und-Organisationen/Standards-und-Zertifizierung/Technische-Richtlinien/TR-nach-Thema-sortiert/tr03165/tr-03165.html). It is a submodule of [GitHub-BSI-TSMS](../README.md). -Swagger-ui documentation of latest TSM-REST-API: [tsm-rest-api.yaml](https://petstore.swagger.io/?url=https://github.com/BSI-Bund/TSMS/blob/master/tsm-rest-api/tsm-rest-api.yaml) +Swagger-ui documentation of latest TSM-REST-API: [tsm-rest-api.yaml](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/BSI-Bund/TSMS/main/tsm-rest-api/dist/1.0.0/tsm-rest-api-1.0.0.yaml) Content: @@ -88,7 +88,7 @@ This project is separated into the following subfolders: |[dist/](dist/)|Contains resulting build artifacts of this project in several versions.| |[docs/](docs/)|Contains a markdown documentation of the java-client for the TSM-Backend REST-API. All files in this folder are generated from the tsm-rest-api.| |[generate-code/](generate-code/)|Contains Maven submodules with several subprojects to generate yaml, json, java and md files related to the TSM-Backend REST-API.| -|[generated-code/](generated-code/)|Contains resulting files when executing the code generation scripts.| +|generated-code/|Contains resulting files when executing the code generation scripts.| @@ -206,7 +206,7 @@ All methods of the TSM-Backend REST-API are described in detail in BSI-TR-03165 Additional documentation generated from the TR is available here: -* Online Swagger UI documentation: [tsm-rest-api.yaml](https://petstore.swagger.io/?url=https://gitlab.governikus.de/smarti/TSMS/-/blob/master/tsm-rest-api/tsm-rest-api.yaml) +* Online Swagger UI documentation: [tsm-rest-api.yaml](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/BSI-Bund/TSMS/main/tsm-rest-api/dist/1.0.0/tsm-rest-api-1.0.0.yaml) * Offline Swagger UI documentation: [tsm-rest-api-1.0.0-swagger-ui.zip](dist/1.0.0/tsm-rest-api-1.0.0-swagger-ui.zip) * Java-Client documentation: [docs/README.md](docs/README.md) diff --git a/tsm-rest-api/generate-code/yaml2javaclient/README.md b/tsm-rest-api/generate-code/yaml2javaclient/README.md index 5001f89..2ec8cc5 100644 --- a/tsm-rest-api/generate-code/yaml2javaclient/README.md +++ b/tsm-rest-api/generate-code/yaml2javaclient/README.md @@ -127,6 +127,6 @@ Usage the Java-Client might slightly change depending on the version of BSI-TR-0 ../../dist/${VERSION}/tsm-rest-api-java-client-${VERSION}-README.zip ``` -The Java-Client Usage documentation for the latest TSM-Backend REST-API can be found inside the parent [Section 3.6 API-Methods](../../README.md#36-api-methods) of the parent README documentation. +The Java-Client Usage documentation for the latest TSM-Backend REST-API can be found inside the parent Section [3.6 API-Methods](../../README.md#api_methods) of the parent README documentation. [Back to TSM-REST-API](../../README.md)