diff --git a/README.md b/README.md index 69e8e910d66459c8b2acdf11b50d6f76b4a19aa4..c1777b416d3c9a8de54f316732256abee0105089 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ To start with TCR project please follow the instructions: [Steps to build TCR](. ## FAQ See our global FAQ Page: https://gitlab.eclipse.org/eclipse/xfsc/train/TRAIN-Documentation#frequently-asked-questions +## Keyword Directory +See our global [Keyword Directory](https://gitlab.eclipse.org/eclipse/xfsc/xfsc-spec-2/-/blob/main/docs/train/train.md?ref_type=heads#definitions-acronyms-and-abbreviations) + ## Roadmap TCR version 1.0.0 was released in December 2023. The current release version is 1.0.5. All TCR releases can be found the standard GitLab [Releases](https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/-/releases) section. diff --git a/clients/go/tcr/docs/Readme.md b/clients/go/tcr/docs/Readme.md deleted file mode 100644 index 569a7e55135477ca31a3a469bd2b363829b13f68..0000000000000000000000000000000000000000 --- a/clients/go/tcr/docs/Readme.md +++ /dev/null @@ -1,32 +0,0 @@ -# How to use the Golang TCR Client library - -In contrast to the js, java and python libraries this one does not require a step to generate the library code. -you can directly use it as you would any other git based Go library. An example: - -``` -package main - -import ( - "context" - "fmt" - "os" - openapiclient "gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver/clients/go/tcr" -) - -func main() { - resolveRequest := *openapiclient.NewResolveRequest("Issuer_example", []string{"TrustSchemePointers_example"}) // ResolveRequest | Verification params - - configuration := openapiclient.NewConfiguration() - apiClient := openapiclient.NewAPIClient(configuration) - resp, r, err := apiClient.TrustedContentResolverAPI.ResolveTrustList(context.Background()).ResolveRequest(resolveRequest).Execute() - if err != nil { - fmt.Fprintf(os.Stderr, "Error when calling `TrustedContentResolverAPI.ResolveTrustList``: %v\n", err) - fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) - } - // response from `ResolveTrustList`: ResolveResponse - fmt.Fprintf(os.Stdout, "Response from `TrustedContentResolverAPI.ResolveTrustList`: %v\n", resp) -} - -``` - -To see the full usage guide go here -> [TrustedContentResolverAPI](./TrustedContentResolverAPI.md) \ No newline at end of file diff --git a/docker/README.md b/docker/README.md index 18a945083f882f5a2cbd3e23fc75ec5a6dd7564f..5f615f5846631553d9ee10e1c986c7395afc378b 100644 --- a/docker/README.md +++ b/docker/README.md @@ -15,7 +15,7 @@ cd <tcr_root_folder> mvn clean install ``` -## Run TCR with external universal-resolver +## Run TCR in docker with external universal-resolver Go to `/docker` folder, use docker compose to start TCR ```bash @@ -25,7 +25,7 @@ Go to `/docker` folder, use docker compose to start TCR In this (default) TCR setup we use external universal-resolver, configured as `TCR_DID_BASE_URI: https://dev.uniresolver.io/1.0` in `docker-compose` file. TCR starts on port `8887` its health can be tested at [http://localhost:8887/actuator/health](http://localhost:8887/actuator/health) page. -## Run TCR with local universal-resolver +## Run TCR in docker with local universal-resolver Go to `/docker` folder. Use docker compose to start universal-resolver with did:web driver only: ```bash diff --git a/docker/unires.env b/docker/unires.env index f18a3d40029757f3ae7f3f608af1c67475ce66fe..6cf63276f2378243623e0314f62c23e174e180f9 100644 --- a/docker/unires.env +++ b/docker/unires.env @@ -1,3 +1,6 @@ +################################# +# DO NOT MODIFY # +################################# COMPOSE_PROJECT_NAME = universal-resolver uniresolver_driver_did_btcr_bitcoinConnection=blockcypherapi diff --git a/docs/build_proc/index.md b/docs/build_proc/index.md index a61a1468f86683b74678bda1235cdeee9e9546d6..ce672895690d7574ea05398bbd24a58411d50f4a 100644 --- a/docs/build_proc/index.md +++ b/docs/build_proc/index.md @@ -7,6 +7,9 @@ First clone the TCR repository: ```bash git clone --recurse-submodules https://gitlab.eclipse.org/eclipse/xfsc/train/trusted-content-resolver.git ``` + +Or, if you already cloned this repo and still need the subrepository run `git submodule update --init` + Then go to the project folder and build it with maven: ```bash diff --git a/openapi/tcr_openapi.yaml b/openapi/tcr_openapi.yaml index 800c01d0a678071b98257631eadd8934d3c103a6..8744591fb0a4e33a30fe7b1c69a75b48026351a3 100644 --- a/openapi/tcr_openapi.yaml +++ b/openapi/tcr_openapi.yaml @@ -9,11 +9,14 @@ info: url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 servers: - - url: https://{tcr-address}/tcr/v1 + - url: {protocol}://{tcr-address}/tcr/v1 variables: tcr-address: default: tcr.train.xfsc.dev description: TCR host/port + protocol: + default: https + description: TCR host/port description: TRAIN XFSC test environment components: diff --git a/service/src/test/java/eu/xfsc/train/tcr/server/service/VCResolveTest.java b/service/src/test/java/eu/xfsc/train/tcr/server/service/VCResolveTest.java index 50ee4bb4656af21485c9ec307d8b9bfa6ff666b7..eee66771bd2d70e6c284092b8c067558e051a0bd 100644 --- a/service/src/test/java/eu/xfsc/train/tcr/server/service/VCResolveTest.java +++ b/service/src/test/java/eu/xfsc/train/tcr/server/service/VCResolveTest.java @@ -159,7 +159,8 @@ public class VCResolveTest { } }"""; - @Test + // Tests disabled as services that are used within those tests are not available anymore. +/* @Test public void testVCResolutionSigner() throws Exception { ResolveRepresentationResult rrr = ResolveRepresentationResult.build(null, docJwkRsa.getBytes(), null); when(uniResolver.resolveRepresentation(eq(didJwkRsa), any())).thenReturn(rrr); @@ -215,5 +216,5 @@ public class VCResolveTest { assertNull(vcRes.getTrustListUri()); assertTrue(vcRes.isVerified()); } - + */ }