Skip to content

Commit b7b5fec

Browse files
committed
Update docs
1 parent 006ba61 commit b7b5fec

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

docs/index.html

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,18 @@
8888
<h1>Welcome to the Apigee Management API command-line interface documentation!<a class="headerlink" href="#welcome-to-the-apigee-management-api-command-line-interface-documentation" title="Link to this heading"></a></h1>
8989
<section id="apigee-cli">
9090
<h2>apigee-cli<a class="headerlink" href="#apigee-cli" title="Link to this heading"></a></h2>
91-
<p>⚠️ Under Maintenance ⚠️</p>
91+
<div class="admonition warning">
92+
<p class="admonition-title">Warning</p>
93+
<p>This tool is no longer actively maintained.</p>
94+
</div>
95+
<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>
96+
<p>Initially developed for Darumatic clients, this project remains available as a working proof of concept, proven reliable in production CI/CD pipelines. The custom plugins feature will remain functional even if Apigee Edge APIs stop working.</p>
97+
<p>I have created private forks for clients, where I continued to add features, fixes, and unit tests. However, I do not intend to maintain this public version. Feel free to explore and learn from the code.</p>
98+
<p>If you’re up for a challenge, try updating the code to work with Apigee X :)</p>
99+
<div class="admonition note">
100+
<p class="admonition-title">Note</p>
101+
<p><strong>apigee-cli</strong> is highly experimental and is not affiliated with Apigee or Google.</p>
102+
</div>
92103
<section id="disclaimer">
93104
<h3>Disclaimer<a class="headerlink" href="#disclaimer" title="Link to this heading"></a></h3>
94105
<p>This is not an officially supported Google product.</p>

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.

docs/source/apigee.backups.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Link to this headi
9292
<span id="apigee-backups-backups-module"></span><h2>apigee.backups.backups module<a class="headerlink" href="#module-apigee.backups.backups" title="Link to this heading"></a></h2>
9393
<dl class="py class">
9494
<dt class="sig sig-object py" id="apigee.backups.backups.BackupConfig">
95-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apigee.backups.backups.</span></span><span class="sig-name descname"><span class="pre">BackupConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">api_choices:</span> <span class="pre">Set[str],</span> <span class="pre">authentication:</span> <span class="pre">apigee.types.Struct,</span> <span class="pre">environments:</span> <span class="pre">List[str],</span> <span class="pre">org_name:</span> <span class="pre">str,</span> <span class="pre">prefix:</span> <span class="pre">Optional[str],</span> <span class="pre">working_directory:</span> <span class="pre">str,</span> <span class="pre">progress_bar:</span> <span class="pre">Any</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">snapshot_data:</span> <span class="pre">apigee.types.Struct</span> <span class="pre">=</span> <span class="pre">&lt;apigee.types.Struct</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7fb9bcb71330&gt;,</span> <span class="pre">snapshot_size:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">0,</span> <span class="pre">working_org_directory:</span> <span class="pre">Optional[pathlib.Path]</span> <span class="pre">=</span> <span class="pre">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#apigee.backups.backups.BackupConfig" title="Link to this definition"></a></dt>
95+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apigee.backups.backups.</span></span><span class="sig-name descname"><span class="pre">BackupConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">api_choices:</span> <span class="pre">Set[str],</span> <span class="pre">authentication:</span> <span class="pre">apigee.types.Struct,</span> <span class="pre">environments:</span> <span class="pre">List[str],</span> <span class="pre">org_name:</span> <span class="pre">str,</span> <span class="pre">prefix:</span> <span class="pre">Optional[str],</span> <span class="pre">working_directory:</span> <span class="pre">str,</span> <span class="pre">progress_bar:</span> <span class="pre">Any</span> <span class="pre">=</span> <span class="pre">None,</span> <span class="pre">snapshot_data:</span> <span class="pre">apigee.types.Struct</span> <span class="pre">=</span> <span class="pre">&lt;apigee.types.Struct</span> <span class="pre">object</span> <span class="pre">at</span> <span class="pre">0x7f9a7802f430&gt;,</span> <span class="pre">snapshot_size:</span> <span class="pre">int</span> <span class="pre">=</span> <span class="pre">0,</span> <span class="pre">working_org_directory:</span> <span class="pre">Optional[pathlib.Path]</span> <span class="pre">=</span> <span class="pre">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#apigee.backups.backups.BackupConfig" title="Link to this definition"></a></dt>
9696
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
9797
<dl class="py attribute">
9898
<dt class="sig sig-object py" id="apigee.backups.backups.BackupConfig.api_choices">

0 commit comments

Comments
 (0)