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

website: Update module-registry-protocol.html.md (#26639)

Browse Source 
* 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
This commit is contained in:
alevinetx 2020-10-28 08:09:52 -05:00 committed by GitHub
parent da1d3cb2d3
commit 66393bb62e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
website/docs/internals/module-registry-protocol.html.md
View File

@ -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: <required>)` - The name of the module.
This is required and is specified as part of the URL path.
- `system` `(string: <required>)` - The name of the target system.
- `provider` `(string: <required>)` - 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: <required>)` - The name of the module.
This is required and is specified as part of the URL path.
- `provider` `(string: <required>)` - The name of the provider.
This is required and is specified as part of the URL path.
- `system` `(string: <required>)` - The name of the target system.
- `provider` `(string: <required>)` - The name of the target system.
This is required and is specified as part of the URL path.
- `version` `(string: <required>)` - The version of the module.