diff --git a/tools/test-proxy/documentation/_images/assets_on_disk.png b/tools/test-proxy/documentation/_images/assets_on_disk.png new file mode 100644 index 00000000000..45fcbb77d1a Binary files /dev/null and b/tools/test-proxy/documentation/_images/assets_on_disk.png differ diff --git a/tools/test-proxy/documentation/_images/example_assets_store.png b/tools/test-proxy/documentation/_images/example_assets_store.png deleted file mode 100644 index 8535e01af06..00000000000 Binary files a/tools/test-proxy/documentation/_images/example_assets_store.png and /dev/null differ diff --git a/tools/test-proxy/documentation/_images/organization_of_assets.png b/tools/test-proxy/documentation/_images/organization_of_assets.png index 8ebb183e648..4d2348e5a21 100644 Binary files a/tools/test-proxy/documentation/_images/organization_of_assets.png and b/tools/test-proxy/documentation/_images/organization_of_assets.png differ diff --git a/tools/test-proxy/documentation/asset-sync/README.md b/tools/test-proxy/documentation/asset-sync/README.md index 16d37b5c6d5..89039a6ea2d 100644 --- a/tools/test-proxy/documentation/asset-sync/README.md +++ b/tools/test-proxy/documentation/asset-sync/README.md @@ -197,19 +197,17 @@ In summary, once an assets.json is present, the shim _must_ be updated to **actu Once a package or service has an assets.json and a targeted tag, each language-repo test framework will automatically provide this assets.json alongside the recording file path. This will allow the test-proxy to automatically restore recordings as necessary. -Here is the result of running tests in `playback`-mode for a couple packages within the python repo: +In practice, this is what a code repo will look like after running `playback`-mode for a couple packages. Specifically, this is for the python repo. -![assets store](../_images/example_assets_store.png) +![assets store](../_images/assets_on_disk.png) One can see the automatically restored assets repos within the `.assets` folder. Each of the top-level folders within the `.assets` folder contains a single slice of the assets repo. -The below diagram illustrates how an individual assets.json, language repo, and assets repo relate to each other. Text that appears as a specific color can be traced to its source in the assets.json. +The below diagram illustrates how an individual assets.json, language repo, and assets repo relate to each other. -![assets diagram](../_images/organization_of_assets.png) +![assets diagram](../_images/organization_of_assets1.png) -> Side note: the `.breadcrumb` file is created/updated as an artifact of the test-proxy restore/push/reset operations. Don't look for one if you haven't restored at least one assets.json first! - -One can use visual inspection of the `.breadcrumb` file to _find_ which folder contains the files for your assets.json. Or, more conveniently, a user can use the `config` verb to access this data! Using assets diagram directly above. we can work an example: +A user can use the `config` verb to access this the location of their assets on disk! Using assets diagram directly as a reference. we can work an example: ```powershell # from the root of the azure-sdk-for-net repo, run: