Atualizando conjuntos de regras e regras com a CLI do kit de ferramentas

Editar online

Use a CLI do kit de ferramentas API Connect para atualizar um conjunto de regras ou regras individuais.

Atualizando um conjunto de regras..

Crie um arquivo JSON que defina o conjunto de regras atualizado..
O exemplo a seguir mostra um conjunto de regras atualizado:
```
{
    "title": "custom-ruleset-2",
    "description": "short ruleset updated",
    "ruleset_type": "custom"
}
```
em que:
- title é atualizado para um novo título do conjunto de regras.
- description é atualizado para uma nova descrição do conjunto de regras.
- O ruleset_type é atualizado para ser customizado para o conjunto de regras
Efetue login no kit de ferramentas como Administrador ou como o proprietário da organização do provedor que possui o conjunto de regras.
Execute o comando do kit de ferramentas rulesets:update no modo governance :
```
apic -m governance rulesets:update --org <target_org> --server <platform_api_host_name> RULESET RULESET_FILE
```
em que:
- <target_org> é o nome da organização que possui o conjunto de regras.
- <platform_api_host_name> é o URL da parte do nome do host do servidor que hospeda o API Manager (o "servidor de gerenciamento").
  
  Dica: para determinar o nome do host, abra o API Manager em um navegador e copie o nome do host do URL na barra de endereços (começando depois de https:// e terminando antes de /manager ).
- RULESET_FILE é o caminho e o nome do arquivo JSON que contém o conjunto de regras atualizado.
- RULESET é o nome ou o ID exclusivo do conjunto de regras atualizado.
  Para determinar o ID de um conjunto de regras, execute o comando a seguir:
```
apic -m governance rulesets:list --org <target_org> --server <platform_api_host_name>
```

Atualizando uma Regra

Crie um arquivo JSON que defina a Regra Atualizada
O exemplo a seguir mostra uma regra atualizada:
```
{
  "description": "Updated the rule",
  "message": "Schema of type array must specify maxItems and minItems. {{path}} {{error}}",
  "formats": [
    "oas3"
  ],
  "severity": "warn",
  "recommended": true,
  "given": [
    "$..[?(@.type==\"array\")]"
  ]
}
```
em que:
- description é atualizado para um novo título para a regra
- message é atualizado para uma nova mensagem para a regra
- formats matriz é substituída para ter apenas o formato oas3 para a regra
- severity é atualizado para o valor de aviso para a regra
- recommended é atualizado para ter um novo valor para a regra
- A matriz given é substituída para ter novos valores para a regra
Efetue login no kit de ferramentas como um Administrador ou como o proprietário da organização do provedor que possui a regra
Execute o comando rules:update toolkit no modo governance .
Há duas maneiras de especificar a regra atualizada no comando, dependendo se você fornecer o nome e a versão da regra ou o ID da regra:
Especifique o nome da regra e a versão no comando update
```
apic -m governance rules:update --org <target_org> --server <platform_api_host_name> --ruleset <ruleset_name or ruleset_id> NAME:VERSION RULE_FILE
```
em que:
- <target_org> é o nome da organização que possui a regra.
- <platform_api_host_name> é o URL da parte do nome do host do servidor que hospeda o API Manager (o "servidor de gerenciamento").
  
  Dica: para determinar o nome do host, abra o API Manager em um navegador e copie o nome do host do URL na barra de endereços (começando depois de https:// e terminando antes de /manager ).
- <ruleset_name or ruleset_id> é o nome ou o ID exclusivo do conjunto de regras ao qual a regra atualizada pertence.
- NAME é o nome da regra atualizada..
- VERSION é a versão da regra atualizada; aumente a versão quando você atualizar a regra, usando o formato major.minor.patch como em "1.0.1".
- RULE_FILE é o caminho e o nome do arquivo JSON que contém a regra atualizada.
Especifique o ID da regra no comando update
Em vez de fornecer o nome e a versão da regra, é possível fornecer seu ID exclusivo executando o comando a seguir:
```
apic -m governance rules:update --org <target_org> --server <platform_api_host_name> --ruleset <ruleset_name or ruleset_id> --id <rule_id> RULE_FILE
```
em que:
- <target_org> é o nome da organização que possui a regra.
- <platform_api_host_name> é o URL da parte do nome do host do servidor que hospeda o API Manager (o "servidor de gerenciamento").
  
  Dica: para determinar o nome do host, abra o API Manager em um navegador e copie o nome do host do URL na barra de endereços (começando depois de https:// e terminando antes de /manager ).
- <ruleset_name or ruleset_id> é o nome ou ID exclusivo do conjunto de regras ao qual a regra de atualização pertence.
- RULE_FILE é o caminho e o nome do arquivo JSON que contém a regra atualizada.
- <rule_id> é o valor do ID exclusivo da regra atualizado.
  Para determinar o ID de uma regra, execute o seguinte comando:
  apic -m governance rules:list --org <target_org> --server <platform_api_host_name> --ruleset <ruleset_name> RULE_NAME