From 66393bb62e94ba50fffd26f3772fc550225c1471 Mon Sep 17 00:00:00 2001 From: alevinetx Date: Wed, 28 Oct 2020 08:09:52 -0500 Subject: [PATCH] website: Update module-registry-protocol.html.md (#26639) * Update module-registry-protocol.html.md 1: There is a mismatch in the segment labels for the version query URL (system vs provider) 2: There is a discrepancy between the documentation and the actual generated request for retrieving module source code (URL segments 4 vs 3) - There is no segment for "provider" * Update module-registry-protocol.html.md Changed ```:system``` to ```:provider``` for versions and source API URLs --- .../docs/internals/module-registry-protocol.html.md | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/website/docs/internals/module-registry-protocol.html.md b/website/docs/internals/module-registry-protocol.html.md index 0369f1127..bb86a70ac 100644 --- a/website/docs/internals/module-registry-protocol.html.md +++ b/website/docs/internals/module-registry-protocol.html.md @@ -123,7 +123,7 @@ available versions for a given fully-qualified module. | Method | Path | Produces | | ------ | ------------------------------------- | -------------------------- | -| `GET` | `:namespace/:name/:provider/versions` | `application/json` | +| `GET` | `:namespace/:name/:provider/versions` | `application/json` | ### Parameters @@ -133,7 +133,7 @@ available versions for a given fully-qualified module. - `name` `(string: )` - The name of the module. This is required and is specified as part of the URL path. -- `system` `(string: )` - The name of the target system. +- `provider` `(string: )` - The name of the target system. This is required and is specified as part of the URL path. ### Sample Request @@ -177,7 +177,7 @@ This endpoint downloads the specified version of a module for a single provider. | Method | Path | Produces | | ------ | ------------------------------------------------------ | -------------------------- | -| `GET` | `:namespace/:name/:provider/:system/:version/download` | `application/json` | +| `GET` | `:namespace/:name/:provider/:version/download` | `application/json` | ### Parameters @@ -187,10 +187,7 @@ This endpoint downloads the specified version of a module for a single provider. - `name` `(string: )` - The name of the module. This is required and is specified as part of the URL path. -- `provider` `(string: )` - The name of the provider. - This is required and is specified as part of the URL path. - -- `system` `(string: )` - The name of the target system. +- `provider` `(string: )` - The name of the target system. This is required and is specified as part of the URL path. - `version` `(string: )` - The version of the module.