Skip to content

Commit

Permalink
corrected invalid links in README documentations
Browse files Browse the repository at this point in the history
  • Loading branch information
a1608 committed Jul 11, 2022
1 parent e1e3fbe commit 290d5cf
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions tsm-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@ This project is a Maven Java project and is structured as follows:
|**Folder**|**Description**|
|:----------|:----------|
|[<em>dist/</em>](dist/)|Contains resulting build artifacts of the project in several versions.|
|[<em>javadocs/</em>](javadocs/)|Generated when building the project. It contains the extracted JavaDoc HTML documentation of the TSM-API.|
|[<em>src/main/java</em>](src/main/java/)|Contains Java source code files of the TSM-API.|
|[<em>target/</em>](target/)|Generated when building the project. It contains temporary build files created by Maven.|
|<em>javadocs/</em>|Generated when building the project. It contains the extracted JavaDoc HTML documentation of the TSM-API.|
|[<em>src/main/java/</em>](src/main/java/)|Contains Java source code files of the TSM-API.|
|<em>target/</em>|Generated when building the project. It contains temporary build files created by Maven.|


<a name="setup_development_environment"></a>
Expand Down Expand Up @@ -115,7 +115,7 @@ For all processes, the smartphone app needs no direct connection to the vendor o

<a name="api_methods"></a>
### 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* |
|:------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
Expand Down
6 changes: 3 additions & 3 deletions tsm-rest-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -88,7 +88,7 @@ This project is separated into the following subfolders:
|[<em>dist/</em>](dist/)|Contains resulting build artifacts of this project in several versions.|
|[<em>docs/</em>](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.|
|[<em>generate-code/</em>](generate-code/)|Contains Maven submodules with several subprojects to generate yaml, json, java and md files related to the TSM-Backend REST-API.|
|[<em>generated-code/</em>](generated-code/)|Contains resulting files when executing the code generation scripts.|
|<em>generated-code/</em>|Contains resulting files when executing the code generation scripts.|


<a name="code_generation"></a>
Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion tsm-rest-api/generate-code/yaml2javaclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 290d5cf

Please sign in to comment.