API マネージャー での ガバナンス の構成

• ルール・セットの編集を続行できます。 たとえば、ナビゲーションページの 「ルール」 の横にある 「ルール を作成」アイコンをクリックして、ルールを追加することができます。 編集が終了したら、必ず 「保存」 をクリックしてください。
• これ以上ルール・セットを編集しない場合は、パンくずリストで 「ガバナンス」 をクリックして、 「API ガバナンス」 概要ページに戻ります。

• ルール・セットの編集を続行できます。 たとえば、ナビゲーションページの 「ルール」 の横にある 「ルール を作成」アイコンをクリックして、ルールを追加することができます。 編集が終了したら、必ず 「保存」 をクリックしてください。
• これ以上ルール・セットを編集しない場合は、パンくずリストで 「ガバナンス」 をクリックして、 「API ガバナンス」 概要ページに戻ります。

次の JSON は、サンプル API ドキュメントの Spectral ルールセット ファイルの内容を示しています。

{
    "name": "short-draft-ootb",
    "title": "short-draft-ootb",
    "description": "short ruleset",
    "ruleset_type": "custom",
    "tags": [
      {
        "name": "general",
        "description": "general work"
      }
    ]
    "rules": [
      {
        "name": "sec-array-boundaries-2",
        "description": "Array size should be limited to mitigate resource exhaustion attacks.\nThis can be done using `maxItems` and `minItems`, like in the example\nbelow.\n\n```\nLimited:\n  type: array\n  maxItems: 10\n  items:\n    type: string\n    format: date\n```\n\nYou should ensure that the schema referenced in  `items` is constrained too.\n\nIf you delegate input validation to a library or framework,\nbe sure to test it thoroughly and ensure that it verifies `maxItems`.",
        "message": "Schema of type array must specify maxItems and minItems. {{path}} {{error}}",
        "formats": [
          "oas3"
        ],
        "severity": "warn",
        "recommended": true,
        "given": [
          "$..[?(@.type==\"array\")]"
        ],
        "then": [
          {
            "field": "maxItems",
            "function": "defined"
          }
        ]
      }
    ]
  }

{
  "type": "ruleset",
  "ruleset_type": "custom",
  "api_version": "2.0.0",
  "id": "dbb5f400-e707-412e-b081-ac36f5afbbb9",
  "name": "test-product",
  "title": "Test Product",
  "description": "",
  "ruleset_version": "1.0.0",
  "ruleset_state": "draft",
  "ruleset_format_type": "2",
  "rule_urls": [
    "https://my.manager.com/governance/orgs/myorg/rulesets/1.0.0-test-product/rules/ca6ef7d9-a503-498e-8f53-4e3aa35d086b"
  ],
  "created_at": "2024-05-22T17:19:02.820Z",
  "updated_at": "2024-05-22T17:24:59.000Z",
  "url": "https://my.manager.com/governance/orgs/myorg/rulesets/dbb5f400-e707-412e-b081-ac36f5afbbb9",
  "rules": [
    {
      "api_version": "2.0.0",
      "id": "ca6ef7d9-a503-498e-8f53-4e3aa35d086b",
      "name": "subscribe",
      "version": "1.0.0",
      "title": "subscribe",
      "description": "subscribe enabled",
      "message": "subscribe not enabled",
      "given": [
        "$.visibility.subscribe.enabled"
      ],
      "severity": "error",
      "created_at": "2024-05-22T17:19:02.000Z",
      "updated_at": "2024-05-22T17:24:59.000Z",
      "url": "https://my.manager.com/governance/orgs/myorg/rulesets/1.0.0-test-product/rules/ca6ef7d9-a503-498e-8f53-4e3aa35d086b",
      "then": [
        {
          "function": "pattern",
          "functionOptions": {
            "notMatch": "/true"
          }
        }
      ]
    }
  ]
}

apic -m governance rulesets:create --org <target_org> --server <server_url> RULESET_FILE

• <target_org> は、新規ルール・セットを所有する組織の名前です。
• <server_url> は、ツールキットへのログインに使用する管理サーバーの URL です。
• RULESET_FILEは、ルールセットを含むJSONファイルのパスとファイル名である。