api-plan

API Plan objects that are created from published products.

  • Override Key: override
  • Child Objects:
    • graphql-schema-options
      • Override Key: override
      • Child Objects:
        • visibility-list
    • rate-limit
      • Child Object:
        • rate-limit-definition
          • Override Key: override
    • burst-limit
      • Child Object:
        • rate-limit-definition
          • Override Key: override
    • rate-limit-group
      • Override Key: override
    • api-operation-rate-limit
      • Override Key: override
      • Child Objects:
        • rate-limit-group
        • rate-limit-definition
    • assembly-limit
      • Child Objects:
        • rate-limit
        • burst-limit
        • count-limit
  • Scopes:
    • global
      • _instance: <planName>.
    • organization
      • _instance: <planName>.
    • catalog
      • _instance: <planName>.
    • product: <name>:<version>
    • _instance: <planName>.
  • Example:
    {
       "api-plan":{
          "_global":{
             "graphql-schema-options":{
                "visibility-list":[
                   "echo hello graphql-schema-options visibility _global"
                ],
                "override":[
                   "echo hello graphql-schema-options _global"
                ]
             },
             "rate-limit":{
                "rate-limit-definition":{
                   "override":[
                      "echo hello rate-limit _global"
                   ]
                }
             },
             "burst-limit":{
                "rate-limit-definition":{
                   "override":[
                      "echo hello burst-limit _global"
                   ]
                }
             },
             "rate-limit-group":{
                "override":[
                   "echo hello rate-limit-group _global"
                ]
             },
             "api-operation-rate-limit":{
                "rate-limit-definition":{
                   "override":[
                      "echo hello api-operation-rate-limit _global"
                   ]
                },
                "rate-limit-group":{
                   "override":[
                      "echo hello api-operation-rate-limit-group _global"
                   ]
                },
                "override":[
                   "echo hello api-operation-rate-limit _global"
                ]
             },
             "assembly-limit":{
                "rate-limit":{
                   "rate-limit-definition":{
                      "override":[
                         "echo hello assemby rate-limit _global"
                      ]
                   }
                },
                "burst-limit":{
                   "rate-limit-definition":{
                      "override":[
                         "echo hello assebmly burst-limit _global"
                      ]
                   }
                },
                "count-limit":{
                   "rate-limit-definition":{
                      "override":[
                         "echo hello assebmly count-limit _global"
                      ]
                   }
                }
             },
             "override":[
                "echo hello api-plan _global"
             ]
          },
          "_organization":{
             "my-org":{
                "override":[
                   "summary hello api-plan _organization"
                ]
             }
          },
          "_catalog":{
             "my-org":{
                "my-catalog":{
                   "override":[
                      "summary hello api-plan _catalog"
                   ]
                }
             }
          },
          "_product":{
             "my-org-2":{
                "my-cat-2":{
                   "my-product:1.0.0":{
                      "override":[
                         "summary hello api-plan _product"
                      ]
                   }
                }
             }
          },
          "_instance":{
             "my-org3":{
                "my-catalog-3":{
                   "my-product:1.0.0":{
                      "my-plan-1":{
                         "override":[
                            "summary hello api-plan _instance"
                         ]
                      }
                   }
                }
             }
          }
       }
    }