From 463340175e7d54dcb67cd26b1e294fc892805bdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20D=C4=85bek?= <373530+szemek@users.noreply.github.com> Date: Fri, 12 Aug 2022 19:41:12 +0200 Subject: [PATCH 1/2] Use consistent naming for path and described parameters --- website/docs/internals/module-registry-protocol.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/internals/module-registry-protocol.mdx b/website/docs/internals/module-registry-protocol.mdx index 1c9f215d74..34d305ae7a 100644 --- a/website/docs/internals/module-registry-protocol.mdx +++ b/website/docs/internals/module-registry-protocol.mdx @@ -121,9 +121,9 @@ the string "versions". This is the primary endpoint for resolving module sources, returning the available versions for a given fully-qualified module. -| Method | Path | Produces | -| ------ | ------------------------------------- | ------------------ | -| `GET` | `:namespace/:name/:provider/versions` | `application/json` | +| Method | Path | Produces | +| ------ | ----------------------------------- | ------------------ | +| `GET` | `:namespace/:name/:system/versions` | `application/json` | ### Parameters @@ -169,11 +169,11 @@ matches against any version constraints given in configuration. ``` Return `404 Not Found` to indicate that no module is available with the -requested namespace, name, and provider +requested namespace, name, and system. ## Download Source Code for a Specific Module Version -This endpoint downloads the specified version of a module for a single provider. +This endpoint downloads the specified version of a module for a single system. | Method | Path | Produces | | ------ | -------------------------------------------- | ------------------ | @@ -187,7 +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 target system. +- `system` `(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. From 39f0d91530e2f070e68809ec0c071541beb2eed7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20D=C4=85bek?= <373530+szemek@users.noreply.github.com> Date: Wed, 17 Aug 2022 18:14:29 +0200 Subject: [PATCH 2/2] Apply suggestions from code review Thanks @laurapacilio! Co-authored-by: Laura Pacilio <83350965+laurapacilio@users.noreply.github.com> --- website/docs/internals/module-registry-protocol.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/docs/internals/module-registry-protocol.mdx b/website/docs/internals/module-registry-protocol.mdx index 34d305ae7a..48310bbe82 100644 --- a/website/docs/internals/module-registry-protocol.mdx +++ b/website/docs/internals/module-registry-protocol.mdx @@ -169,11 +169,11 @@ matches against any version constraints given in configuration. ``` Return `404 Not Found` to indicate that no module is available with the -requested namespace, name, and system. +requested namespace, name, and target system. ## Download Source Code for a Specific Module Version -This endpoint downloads the specified version of a module for a single system. +This endpoint downloads the specified version of a module for a single target system. | Method | Path | Produces | | ------ | -------------------------------------------- | ------------------ |