Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added data redaction settings endpoint #69

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

added data redaction settings endpoint #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
327 changes: 309 additions & 18 deletions public/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -390,6 +390,12 @@ <h5>Operations</h5>
<li>
<a href="#operation--services--env_id--settings-data-redaction-packages--package_name--delete"> Delete package </a>
</li>
<li>
<a href="#operation--services--env_id--settings-data-redaction-advanced-get"> Get data redaction advanced settings for an environment </a>
</li>
<li>
<a href="#operation--services--env_id--settings-data-redaction-advanced-post"> Set data redaction advanced settings for an environment </a>
</li>
</ul>
</section>
<section>
Expand Down Expand Up @@ -520,6 +526,8 @@ <h5>Schema Definitions</h5>
<a href="#definition-Pattern"> Pattern </a>
<a href="#definition-ClassName"> ClassName </a>
<a href="#definition-PackageName"> PackageName </a>
<a href="#definition-CodeIdentifier"> CodeIdentifier </a>
<a href="#definition-DataRedactionSettings"> DataRedactionSettings </a>
<a href="#definition-ViewBasic"> ViewBasic </a>
<a href="#definition-ViewFull"> ViewFull </a>
<a href="#definition-Category"> Category </a>
Expand Down Expand Up @@ -13153,20 +13161,17 @@ <h2 class="operation-title">
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">200 OK</div>
<div class="prop-ref"></div>
<div class="prop-ref">
<span class="">
<a class="json-schema-ref" href="#/definitions/CodeIdentifier">CodeIdentifier</a>
</span>
</div>
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
</div>
<div class="prop-value">
<p>If the redaction exists</p>
</div>
</div>
<div class="prop-row prop-inner">
<div class="prop-name">type</div>
<div class="prop-value">
<span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>
</div>
</div>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">401 Unauthorized</div>
Expand Down Expand Up @@ -13221,16 +13226,20 @@ <h2 class="operation-title">
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-request-body">
<p>Identifier object</p>
<section class="json-schema-properties">
<dl>
<dt data-property-name="name">
<span class="json-property-name">name:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
</dl>
</section>
<div class="prop-row">
<div class="prop-name">
<div class="swagger-request-model">
<span class="">
<a class="json-schema-ref" href="#/definitions/CodeIdentifier">CodeIdentifier</a>
</span>
</div>
</div>
<div class="prop-value columns small-6">
<!-- <div class="swagger-request-description"> -->
<p>Identifier object</p>
<!-- </div> -->
</div>
</div>
</section>
<section class="swagger-request-params">
<div class="prop-row prop-group">
Expand Down Expand Up @@ -14221,6 +14230,216 @@ <h2 class="operation-title">
<div class="doc-examples"> </div>
</div>
</div>
<div id="operation--services--env_id--settings-data-redaction-advanced-get" class="operation panel" data-traverse-target="operation--services--env_id--settings-data-redaction-advanced-get">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<a class="label" href="#tag-Data-Redaction">Data Redaction</a>
<!---->
</div>
<!-- </div> -->
<!-- </section> -->
<h2 class="operation-title">
<span class="operation-summary">Get data redaction advanced settings for an environment</span>
</h2>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-operation-path">
<span class="operation-method">GET</span>
<span class="operation-path">/services/{env_id}/settings/data-redaction/advanced</span>
</section>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-operation-description">
<p>Get data redaction advanced settings for an environment</p>
</section>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-request-params">
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">env_id</div>
<span class="json-property-required"></span>
<div class="prop-subtitle"> in path </div>
<div class="prop-subtitle">
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</div>
</div>
<div class="prop-value">
<p>Environment to use</p>
</div>
</div>
</section>
</div>
<div class="doc-examples"></div>
</div>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-responses">
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">200 OK</div>
<div class="prop-ref">
<span class="">
<a class="json-schema-ref" href="#/definitions/DataRedactionSettings">DataRedactionSettings</a>
</span>
</div>
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
</div>
<div class="prop-value">
<p>Data Redaction advanced settings</p>
</div>
</div>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">401 Unauthorized</div>
</div>
<div class="prop-value">
<p>Unauthorized</p>
</div>
</div>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">404 Not Found</div>
</div>
<div class="prop-value">
<p>Not Found</p>
</div>
</div>
</section>
</div>
<div class="doc-examples">
<section>
<h5>Response Example
<span>(200 OK)</span>
</h5>
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
<span class="hljs-attr">&quot;apply_identifiers_on_maps&quot;</span>: <span class="hljs-literal">true</span>
}
</code></pre>
<!-- </div> -->
</section>
</div>
</div>
</div>
<div id="operation--services--env_id--settings-data-redaction-advanced-post" class="operation panel" data-traverse-target="operation--services--env_id--settings-data-redaction-advanced-post">
<!-- <section class="operation-tags row"> -->
<!-- <div class="doc-copy"> -->
<div class="operation-tags">
<a class="label" href="#tag-Data-Redaction">Data Redaction</a>
<!---->
</div>
<!-- </div> -->
<!-- </section> -->
<h2 class="operation-title">
<span class="operation-summary">Set data redaction advanced settings for an environment</span>
</h2>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-operation-path">
<span class="operation-method">POST</span>
<span class="operation-path">/services/{env_id}/settings/data-redaction/advanced</span>
</section>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-operation-description">
<p>Set data redaction advanced settings for an environment</p>
</section>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-request-body">
<div class="prop-row">
<div class="prop-name">
<div class="swagger-request-model">
<span class="">
<a class="json-schema-ref" href="#/definitions/DataRedactionSettings">DataRedactionSettings</a>
</span>
</div>
</div>
<div class="prop-value columns small-6">
<!-- <div class="swagger-request-description"> -->
<p>undefined</p>
<!-- </div> -->
</div>
</div>
</section>
<section class="swagger-request-params">
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">env_id</div>
<span class="json-property-required"></span>
<div class="prop-subtitle"> in path </div>
<div class="prop-subtitle">
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</div>
</div>
<div class="prop-value">
<p>Environment to use</p>
</div>
</div>
</section>
</div>
<div class="doc-examples">
<section>
<h5>Request Example</h5>
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
<span class="hljs-attr">&quot;apply_identifiers_on_maps&quot;</span>: <span class="hljs-literal">true</span>
}
</code></pre>
<!-- </div> -->
</section>
</div>
</div>
<div class="doc-row">
<div class="doc-copy">
<section class="swagger-responses">
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">200 OK</div>
</div>
<div class="prop-value">
<p>OK</p>
</div>
</div>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">400 Bad Request</div>
</div>
<div class="prop-value">
<p>Bad Request</p>
</div>
</div>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">401 Unauthorized</div>
</div>
<div class="prop-value">
<p>Unauthorized</p>
</div>
</div>
<div class="prop-row prop-group">
<div class="prop-name">
<div class="prop-title">404 Not Found</div>
</div>
<div class="prop-value">
<p>Not Found</p>
</div>
</div>
</section>
</div>
<div class="doc-examples"> </div>
</div>
</div>
<h1 id="tag-Code-Redaction" class="swagger-summary-tag" data-traverse-target="tag-Code-Redaction">Code Redaction</h1>
<div class="tag-description doc-row">
<div class="doc-copy">
Expand Down Expand Up @@ -18285,6 +18504,78 @@ <h2 class="panel-title">
<div class="doc-copy"> </div>
</div>
</div>
<div id="definition-CodeIdentifier" class="definition panel" data-traverse-target="definition-CodeIdentifier">
<h2 class="panel-title">
<a name="/definitions/CodeIdentifier"></a>CodeIdentifier: object
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>


</span> -->
</h2>
<div class="doc-row">
<div class="doc-copy">
<section class="json-schema-properties">
<dl>
<dt data-property-name="name">
<span class="json-property-name">name:</span>
<span class="json-property-type">string</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
</dl>
</section>
</div>
<div class="doc-examples">
<section>
<h5>Example</h5>
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
<span class="hljs-attr">&quot;name&quot;</span>: <span class="hljs-string">&quot;password&quot;</span>
}
</code></pre>
<!-- </div> -->
</section>
</div>
</div>
</div>
<div id="definition-DataRedactionSettings" class="definition panel" data-traverse-target="definition-DataRedactionSettings">
<h2 class="panel-title">
<a name="/definitions/DataRedactionSettings"></a>DataRedactionSettings: object
<!-- <span class="json-property-type"><span class="json-property-type">object</span>
<span class="json-property-range" title="Value limits"></span>


</span> -->
</h2>
<div class="doc-row">
<div class="doc-copy">
<section class="json-schema-description">
<p>Data redaction advanced settings</p>
</section>
<section class="json-schema-properties">
<dl>
<dt data-property-name="apply_identifiers_on_maps" class="has-description">
<span class="json-property-name">apply_identifiers_on_maps:</span>
<span class="json-property-type">boolean</span>
<span class="json-property-range" title="Value limits"></span>
</dt>
<dd>
<p>Apply defined code identifiers to maps. When the value is set to false, only variables with names which are matching to the code identifiers will be redcacted. When set to true, both variables with matching names, and map keys with matching names will be redacted.</p>
</dd>
</dl>
</section>
</div>
<div class="doc-examples">
<section>
<h5>Example</h5>
<!-- <div class="hljs"> --><pre><code class="hljs lang-json">{
<span class="hljs-attr">&quot;apply_identifiers_on_maps&quot;</span>: <span class="hljs-literal">true</span>
}
</code></pre>
<!-- </div> -->
</section>
</div>
</div>
</div>
<div id="definition-ViewBasic" class="definition panel" data-traverse-target="definition-ViewBasic">
<h2 class="panel-title">
<a name="/definitions/ViewBasic"></a>ViewBasic: object
Expand Down
Loading