Skip to content

Commit

Permalink
docs: marketplace features removed from alpha build (#222)
Browse files Browse the repository at this point in the history
  • Loading branch information
ThisIsDemetrio authored Sep 10, 2024
1 parent 7e79367 commit 7717ee7
Showing 1 changed file with 12 additions and 53 deletions.
65 changes: 12 additions & 53 deletions docs/30_commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ Available flags for the command:
- `--project-id`, to set the ID of the desired Project
- `--environment`, to set the environment scope for the command


:::warning
If you want to use `miactl` with a _Service Account_, **remember to specify** the `--auth-name` flag, otherwise _miactl_ will try to perform a _User Login_, opening the browser for authentication the user.
:::
Expand Down Expand Up @@ -79,6 +78,7 @@ miactl context auth NAME [flags]
```

Available flags:

- `--client-id string`: the client ID of the service account
- `--client-secret string`: the client secret of the service account
- `-h, --help`: help for auth
Expand Down Expand Up @@ -937,7 +937,7 @@ List Marketplace items
#### Synopsis
List the Marketplace items that the current user can access.
List the Marketplace items that the current user can access.
#### Usage
Expand All @@ -947,43 +947,26 @@ miactl marketplace list --company-id company-id [FLAGS]...
#### Flags
* `--public` - if this flag is set, the command fetches not only the items from the requested company, but also the public Marketplace items from other companies.
- `--public` - if this flag is set, the command fetches not only the items from the requested company, but also the public Marketplace items from other companies.
### get
Get a Marketplace item
#### Synopsis
##### Stable version
Get a single Marketplace item
You need to specify the ObjectID of the item with the flag object-id
```bash
miactl marketplace get --object-id object-id [FLAGS]...
```
##### Alpha version
:::warning
This command is in ALPHA state. This means that it can be subject to breaking changes in the next versions of miactl.
:::
Get a single Marketplace item
You need to specify either:
- the companyId, itemId and version, via the respective flags (recommended). The company-id flag can be omitted if it is already set in the context.
- the ObjectID of the item with the flag object-id
Passing the ObjectID is expected only when dealing with deprecated Marketplace items missing the itemId and/or version fields.
Otherwise, it is preferable to pass the tuple companyId-itemId-version.
```bash
miactl marketplace get { --item-id item-id --version version } | --object-id object-id [FLAGS]...
miactl marketplace get { --item-id item-id --version version } | --object-id objectID [FLAGS]...
```
### delete
Expand All @@ -992,27 +975,10 @@ Delete a Marketplace item
#### Synopsis
##### Stable version
Delete a single Marketplace item
You need to specify the ObjectID of the item with the flag object-id
```bash
miactl marketplace get --object-id object-id [FLAGS]...
```
#### ALPHA version
:::warning
This command is in ALPHA state. This means that it can be subject to breaking changes in the next versions of miactl.
:::
Delete a single Marketplace item
You need to specify either:
- the companyId, itemId and version, via the respective flags (recommended). The company-id flag can be omitted if it is already set in the context.
- the ObjectID of the item with the flag object-id
Expand Down Expand Up @@ -1050,16 +1016,15 @@ You can retrieve the updated item with the "get" command.
You can also specify the "supportedByImage" in a similar way.
Be aware that the presence of both "image" and "imageUrl" and/or of both "supportedByImage" and "supportedByImageUrl" is ambiguous and raises an error .
Be aware that the presence of both "image" and "imageUrl" and/or of both "supportedByImage" and "supportedByImageUrl" is ambiguous and raises an error.
```
```bash
miactl marketplace apply { -f file-path }... } [flags]
```
#### Examples
```
```bash
# Apply the configuration of the file myFantasticGoTemplate.json located in the current directory to the Marketplace
miactl marketplace apply -f myFantasticGoTemplate.json
Expand All @@ -1073,25 +1038,19 @@ miactl marketplace apply -f myFantasticGoTemplates
#### Options
```
```bash
-f, --file stringArray paths to JSON/YAML files or folder of files containing a Marketplace item definition
-h, --help help for apply
```
### list-versions (ALPHA)
:::warning
This command is in ALPHA state. This means that it can be subject to breaking changes in the next versions of miactl.
:::
### list-versions
List all the available versions of a specific Marketplace item.
#### Synopsis
The flag `--item-id` or `-i` accepts the `itemId` of the Item.
```
```bash
miactl marketplace list-versions -i some-item
```

0 comments on commit 7717ee7

Please sign in to comment.