Skip to content

Commit

Permalink
Clarify procedure for performing a soft-delete in deprecating-a-data-…
Browse files Browse the repository at this point in the history
…package
  • Loading branch information
servilla committed Oct 29, 2024
1 parent f4c9255 commit 7301f6c
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions templates/resources/deprecating-a-data-package.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,14 @@ <h2 id="step-1-notify-users-about-the-deprecation">Step 1 - Notify users about t
<p><img alt="Deprecation notice" class="screen-shot" src="/static/images/deprecation-notice.png" width="85%"/></p>
<p>Once the metadata edits are complete, the changes will have to be uploaded via <a href="/resources/updating-a-data-package">data package update</a>.</p>
<h2 id="step-2-soft-delete-the-data-package">Step 2 - "Soft delete" the data package</h2>
<p>Execute a "soft delete" of the data package. Any data package owner can perform this operation using <a href="https://en.wikipedia.org/wiki/CURL" rel="noopener noreferrer" target="_blank">curl</a> or another HTTP-based application that can send a "DELETE" request. The delete method is described in the <a href="https://nam02.safelinks.protection.outlook.com/?url=https%3A%2F%2Fpasta.lternet.edu%2Fpackage%2Fdocs%2Fapi%23DELETE%2520%3A%2520%2Feml%2F%257Bscope%257D%2F%257Bidentifier%257D&amp;data=05%7C01%7Cjfutrelle%40whoi.edu%7C4786c822c02c43dedc0d08dabce50e7e%7Cd44c5cc6d18c46cc8abd4fdf5b6e5944%7C0%7C0%7C638029989235147987%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&amp;sdata=ewGg%2BUuazIME6VLxGHE2hjVBXr51p8uVdXxRmSZeEE8%3D&amp;reserved=0" rel="noopener noreferrer" target="_blank">API documentation</a>. Note that the entire series will be "soft deleted", so use only the data package scope and identifier in the DELETE request. For example the command</p>
<pre><code>curl --user 'uid=NES,o=EDI,dc=edirepository,dc=org:&lt;PASSWORD&gt;' -X DELETE 'https://pasta.lternet.edu/package/eml/knb-lter-nes/7'
<p>Execute a "soft delete" of the data package. Any data package owner can perform this operation using <a href="https://en.wikipedia.org/wiki/CURL" rel="noopener noreferrer" target="_blank">cURL</a> or another HTTP-based application that can send a "DELETE" request. The delete method is described in the <a href="https://pasta.lternet.edu/package/docs/api#DELETE%20:%20/eml/%7Bscope%7D/%7Bidentifier%7D" rel="noopener noreferrer" target="_blank">API documentation</a>. Note that the entire series will be "soft deleted", so use only the data package scope and identifier in the DELETE request. To perform a "soft delete" using <code>cURL</code> you would need to set the "user" and "request method" parameters to identify the owner of the data package and the <code>DELETE</code> mehtod. The full <code>cURL</code> command would look like</p>
<pre><code>curl --user &lt;USER&gt;:&lt;PASSWORD&gt; -X DELETE &lt;URL&gt;
</code></pre>
<p>will "soft delete" all data package revisions in the <strong>knb-lter-nes.7</strong> series.</p>
<p>The PASTA API requires the "user" parameter to be the full EDI LDAP distinguished name (e.g., <code>uid=ecoridge,o=EDI,dc=edirepository,dc=org</code>), where the "uid" field is the identifier used to login into the Data Portal when publishing a data package.</p>
<p>For example, the command</p>
<pre><code>curl --user 'uid=ecoridge,o=EDI,dc=edirepository,dc=org:asd9wkjas38' -X DELETE 'https://pasta.lternet.edu/package/eml/edi/7'
</code></pre>
<p>will "soft delete" all data package revisions of the <strong>edi.7</strong> series in the EDI production environment. To perform a "soft delete" on your data package replace the identifier "ecoridge" and the password "asd9wkjas38" with your own user identifier and password. You may also perform a "soft delete" in the EDI staging environment by replacing <code>pasta.lternet.edu</code> with <code>pasta-s.lternet.edu</code> in the URL.</p>
<blockquote>
<p>Please <a href="/support/contact-us">contact us</a> if you need help deleting a data package.</p>
</blockquote>
Expand Down

0 comments on commit 7301f6c

Please sign in to comment.