IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2024-12-28 01:41:48 -06:00
Code Issues Packages Projects Releases Wiki Activity

Use consistent naming for path and described parameters

Browse Source
This commit is contained in:
Przemysław Dąbek 2022-08-12 19:41:12 +02:00 committed by GitHub
parent 2aff67857f
commit 463340175e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/docs/internals/module-registry-protocol.mdx
View File

@ -121,9 +121,9 @@ the string "versions".
This is the primary endpoint for resolving module sources, returning the This is the primary endpoint for resolving module sources, returning the
available versions for a given fully-qualified module. available versions for a given fully-qualified module.
| Method | Path | Produces | | Method | Path | Produces |
| ------ | ------------------------------------- | ------------------ | | ------ | ----------------------------------- | ------------------ |
| `GET` | `:namespace/:name/:provider/versions` | `application/json` | | `GET` | `:namespace/:name/:system/versions` | `application/json` |
### Parameters ### 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 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 ## 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 | | Method | Path | Produces |
| ------ | -------------------------------------------- | ------------------ | | ------ | -------------------------------------------- | ------------------ |
@ -187,7 +187,7 @@ This endpoint downloads the specified version of a module for a single provider.
- `name` `(string: <required>)` - The name of the module. - `name` `(string: <required>)` - The name of the module.
This is required and is specified as part of the URL path. This is required and is specified as part of the URL path.
- `provider` `(string: <required>)` - The name of the target system. - `system` `(string: <required>)` - The name of the target system.
This is required and is specified as part of the URL path. This is required and is specified as part of the URL path.
- `version` `(string: <required>)` - The version of the module. - `version` `(string: <required>)` - The version of the module.