Skip to content

Commit 4d37e8f

Browse files
committed
Update docs
1 parent 8011414 commit 4d37e8f

File tree

6 files changed

+128
-60
lines changed

6 files changed

+128
-60
lines changed

docs/genindex.html

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -759,13 +759,13 @@ <h2 id="C">C</h2>
759759
</li>
760760
<li><a href="source/apigee.html#apigee.utils.check_files_exist">check_files_exist() (in module apigee.utils)</a>
761761
</li>
762-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.chmod_directory">chmod_directory() (in module apigee.plugins.commands)</a>
762+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.FileUtils.chmod_directory">chmod_directory() (apigee.plugins.commands.FileUtils static method)</a>
763763
</li>
764764
<li><a href="source/apigee.caches.html#apigee.caches.caches.Caches.clear_a_cache_entry">clear_a_cache_entry() (apigee.caches.caches.Caches method)</a>
765765
</li>
766766
<li><a href="source/apigee.caches.html#apigee.caches.caches.Caches.clear_all_cache_entries">clear_all_cache_entries() (apigee.caches.caches.Caches method)</a>
767767
</li>
768-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.clone_plugin_repositories">clone_plugin_repositories() (in module apigee.plugins.commands)</a>
768+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.clone_repositories">clone_repositories() (apigee.plugins.commands.PluginManager static method)</a>
769769
</li>
770770
<li><a href="source/apigee.backups.html#apigee.backups.backups.ProgressTracker.close">close() (apigee.backups.backups.ProgressTracker method)</a>
771771
</li>
@@ -929,7 +929,7 @@ <h2 id="E">E</h2>
929929
</li>
930930
<li><a href="source/apigee.html#apigee.utils.execute_function_on_directory_files">execute_function_on_directory_files() (in module apigee.utils)</a>
931931
</li>
932-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.exit_quietly_if_git_not_installed">exit_quietly_if_git_not_installed() (in module apigee.plugins.commands)</a>
932+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.GitUtils.exit_if_not_installed">exit_if_not_installed() (apigee.plugins.commands.GitUtils static method)</a>
933933
</li>
934934
</ul></td>
935935
<td style="width: 33%; vertical-align: top;"><ul>
@@ -981,6 +981,8 @@ <h2 id="F">F</h2>
981981
</li>
982982
</ul></td>
983983
<td style="width: 33%; vertical-align: top;"><ul>
984+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.FileUtils">FileUtils (class in apigee.plugins.commands)</a>
985+
</li>
984986
<li><a href="source/apigee.apis.html#apigee.apis.serializer.ApisSerializer.filter_deployed_revisions">filter_deployed_revisions() (apigee.apis.serializer.ApisSerializer static method)</a>
985987

986988
<ul>
@@ -1067,10 +1069,10 @@ <h2 id="G">G</h2>
10671069
</li>
10681070
<li><a href="source/apigee.html#apigee.auth.get_config_value">get_config_value() (in module apigee.auth)</a>
10691071
</li>
1070-
</ul></td>
1071-
<td style="width: 33%; vertical-align: top;"><ul>
10721072
<li><a href="source/apigee.maskconfigs.html#apigee.maskconfigs.maskconfigs.Maskconfigs.get_data_mask_details_for_an_api_proxy">get_data_mask_details_for_an_api_proxy() (apigee.maskconfigs.maskconfigs.Maskconfigs method)</a>
10731073
</li>
1074+
</ul></td>
1075+
<td style="width: 33%; vertical-align: top;"><ul>
10741076
<li><a href="source/apigee.apis.html#apigee.apis.api_puller_with_dependency_extraction.CachesExporter.get_dependencies">get_dependencies() (apigee.apis.api_puller_with_dependency_extraction.CachesExporter method)</a>
10751077

10761078
<ul>
@@ -1096,6 +1098,8 @@ <h2 id="G">G</h2>
10961098
<li><a href="source/apigee.apps.html#apigee.apps.apps.Apps.get_org_app">get_org_app() (apigee.apps.apps.Apps method)</a>
10971099
</li>
10981100
<li><a href="source/apigee.permissions.html#apigee.permissions.permissions.Permissions.get_permissions">get_permissions() (apigee.permissions.permissions.Permissions method)</a>
1101+
</li>
1102+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.get_plugin_info">get_plugin_info() (apigee.plugins.commands.PluginManager static method)</a>
10991103
</li>
11001104
<li><a href="source/apigee.references.html#apigee.references.references.References.get_reference">get_reference() (apigee.references.references.References method)</a>
11011105
</li>
@@ -1124,6 +1128,8 @@ <h2 id="G">G</h2>
11241128
<li><a href="source/apigee.apis.html#apigee.apis.deploy.getElementText">getElementText() (in module apigee.apis.deploy)</a>
11251129
</li>
11261130
<li><a href="source/apigee.apis.html#apigee.apis.deploy.getElementVal">getElementVal() (in module apigee.apis.deploy)</a>
1131+
</li>
1132+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.GitUtils">GitUtils (class in apigee.plugins.commands)</a>
11271133
</li>
11281134
</ul></td>
11291135
</tr></table>
@@ -1151,9 +1157,7 @@ <h2 id="I">I</h2>
11511157
</li>
11521158
<li><a href="source/apigee.html#apigee.utils.import_plugins_from_directory">import_plugins_from_directory() (in module apigee.utils)</a>
11531159
</li>
1154-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.initialize_and_save_plugin_config">initialize_and_save_plugin_config() (in module apigee.plugins.commands)</a>
1155-
</li>
1156-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.initialize_apigee_cli_plugins">initialize_apigee_cli_plugins() (in module apigee.plugins.commands)</a>
1160+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.initialize_plugins">initialize_plugins() (apigee.plugins.commands.PluginManager static method)</a>
11571161
</li>
11581162
</ul></td>
11591163
<td style="width: 33%; vertical-align: top;"><ul>
@@ -1219,10 +1223,10 @@ <h2 id="L">L</h2>
12191223
</li>
12201224
<li><a href="source/apigee.maskconfigs.html#apigee.maskconfigs.maskconfigs.Maskconfigs.list_data_masks_for_an_organization">list_data_masks_for_an_organization() (apigee.maskconfigs.maskconfigs.Maskconfigs method)</a>
12211225
</li>
1222-
</ul></td>
1223-
<td style="width: 33%; vertical-align: top;"><ul>
12241226
<li><a href="source/apigee.apps.html#apigee.apps.apps.Apps.list_developer_apps">list_developer_apps() (apigee.apps.apps.Apps method)</a>
12251227
</li>
1228+
</ul></td>
1229+
<td style="width: 33%; vertical-align: top;"><ul>
12261230
<li><a href="source/apigee.developers.html#apigee.developers.developers.Developers.list_developers">list_developers() (apigee.developers.developers.Developers method)</a>
12271231
</li>
12281232
<li><a href="source/apigee.keyvaluemaps.html#apigee.keyvaluemaps.keyvaluemaps.Keyvaluemaps.list_keys_in_an_environment_scoped_keyvaluemap">list_keys_in_an_environment_scoped_keyvaluemap() (apigee.keyvaluemaps.keyvaluemaps.Keyvaluemaps method)</a>
@@ -1232,14 +1236,16 @@ <h2 id="L">L</h2>
12321236
<li><a href="source/apigee.apps.html#apigee.apps.apps.Apps.list_org_apps">list_org_apps() (apigee.apps.apps.Apps method)</a>
12331237
</li>
12341238
<li><a href="source/apigee.userroles.html#apigee.userroles.userroles.Userroles.list_permissions_for_a_resource">list_permissions_for_a_resource() (apigee.userroles.userroles.Userroles method)</a>
1239+
</li>
1240+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.list_sources">list_sources() (apigee.plugins.commands.PluginManager static method)</a>
12351241
</li>
12361242
<li><a href="source/apigee.targetservers.html#apigee.targetservers.targetservers.Targetservers.list_targetservers_in_an_environment">list_targetservers_in_an_environment() (apigee.targetservers.targetservers.Targetservers method)</a>
12371243
</li>
12381244
<li><a href="source/apigee.userroles.html#apigee.userroles.userroles.Userroles.list_user_roles">list_user_roles() (apigee.userroles.userroles.Userroles method)</a>
12391245
</li>
12401246
<li><a href="source/apigee.virtualhosts.html#apigee.virtualhosts.virtualhosts.Virtualhosts.list_virtual_hosts_for_an_environment">list_virtual_hosts_for_an_environment() (apigee.virtualhosts.virtualhosts.Virtualhosts method)</a>
12411247
</li>
1242-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.load_plugin_config">load_plugin_config() (in module apigee.plugins.commands)</a>
1248+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.load_config">load_config() (apigee.plugins.commands.PluginManager static method)</a>
12431249
</li>
12441250
<li><a href="source/apigee.html#apigee.exceptions.log_and_echo_http_error">log_and_echo_http_error() (in module apigee.exceptions)</a>
12451251
</li>
@@ -1441,18 +1447,26 @@ <h2 id="P">P</h2>
14411447
<li><a href="source/apigee.permissions.html#apigee.permissions.permissions.Permissions">Permissions (class in apigee.permissions.permissions)</a>
14421448
</li>
14431449
<li><a href="source/apigee.permissions.html#apigee.permissions.serializer.PermissionsSerializer">PermissionsSerializer (class in apigee.permissions.serializer)</a>
1450+
</li>
1451+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager">PluginManager (class in apigee.plugins.commands)</a>
14441452
</li>
14451453
<li><a href="source/apigee.backups.html#apigee.backups.backups.BackupConfig.prefix">prefix (apigee.backups.backups.BackupConfig attribute)</a>
14461454
</li>
1447-
<li><a href="source/apigee.apis.html#apigee.apis.deploy.printDeployments">printDeployments() (in module apigee.apis.deploy)</a>
1455+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.print_dependencies">print_dependencies() (apigee.plugins.commands.PluginManager static method)</a>
14481456
</li>
1449-
<li><a href="source/apigee.backups.html#apigee.backups.backups.BackupConfig.progress_bar">progress_bar (apigee.backups.backups.BackupConfig attribute)</a>
1457+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.print_full_info">print_full_info() (apigee.plugins.commands.PluginManager static method)</a>
1458+
</li>
1459+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.print_latest_commit">print_latest_commit() (apigee.plugins.commands.PluginManager static method)</a>
14501460
</li>
14511461
</ul></td>
14521462
<td style="width: 33%; vertical-align: top;"><ul>
1463+
<li><a href="source/apigee.apis.html#apigee.apis.deploy.printDeployments">printDeployments() (in module apigee.apis.deploy)</a>
1464+
</li>
1465+
<li><a href="source/apigee.backups.html#apigee.backups.backups.BackupConfig.progress_bar">progress_bar (apigee.backups.backups.BackupConfig attribute)</a>
1466+
</li>
14531467
<li><a href="source/apigee.backups.html#apigee.backups.backups.ProgressTracker">ProgressTracker (class in apigee.backups.backups)</a>
14541468
</li>
1455-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.prune_unused_plugin_directories">prune_unused_plugin_directories() (in module apigee.plugins.commands)</a>
1469+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.prune_unused_directories">prune_unused_directories() (apigee.plugins.commands.PluginManager static method)</a>
14561470
</li>
14571471
<li><a href="source/apigee.apiproducts.html#apigee.apiproducts.apiproducts.Apiproducts.push_apiproducts">push_apiproducts() (apigee.apiproducts.apiproducts.Apiproducts method)</a>
14581472
</li>
@@ -1632,7 +1646,7 @@ <h2 id="U">U</h2>
16321646
</li>
16331647
<li><a href="source/apigee.keyvaluemaps.html#apigee.keyvaluemaps.keyvaluemaps.Keyvaluemaps.update_keyvaluemap_in_an_environment">update_keyvaluemap_in_an_environment() (apigee.keyvaluemaps.keyvaluemaps.Keyvaluemaps method)</a>
16341648
</li>
1635-
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.update_plugin_repositories">update_plugin_repositories() (in module apigee.plugins.commands)</a>
1649+
<li><a href="source/apigee.plugins.html#apigee.plugins.commands.PluginManager.update_repositories">update_repositories() (apigee.plugins.commands.PluginManager static method)</a>
16361650
</li>
16371651
<li><a href="source/apigee.backups.html#apigee.backups.backups.UserRoleHandler">UserRoleHandler (class in apigee.backups.backups)</a>
16381652
</li>

docs/index.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,10 @@ <h2>apigee-cli<a class="headerlink" href="#apigee-cli" title="Link to this headi
9292
<p class="admonition-title">Warning</p>
9393
<p>This tool is no longer actively maintained.</p>
9494
</div>
95+
<div class="admonition warning">
96+
<p class="admonition-title">Warning</p>
97+
<p>We primarily use and test with SSO; basic and MFA authentication may still work, but we no longer actively use or verify them.</p>
98+
</div>
9599
<p>The Apigee Edge command-line interface is an unofficial Python command-line tool built to simplify and automate Apigee Edge API usage, with support for SSO, MFA, and basic authentication.</p>
96100
<section id="why-use-this-instead-of-the-official-tool">
97101
<h3>Why use this instead of the official tool<a class="headerlink" href="#why-use-this-instead-of-the-official-tool" title="Link to this heading"></a></h3>

docs/objects.inv

40 Bytes
Binary file not shown.

docs/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)