Skip to content
Permalink
Browse files

feat: delete-installation, get-org-installation, get-repo-installatio…

…n. Deprecates find-org-installation, find-repo-installation (#399)

documentation URL update for create-content-attachment
  • Loading branch information...
octokitbot authored and gr2m committed Apr 18, 2019
1 parent 8addb64 commit f66d4f5b54a11da59a08a830ae02ef2440870a54
Showing 385 changed files with 5,057 additions and 2,883 deletions.
@@ -1,7 +1,7 @@
<h2>
<a id="contentreferenceevent" class="anchor" href="#contentreferenceevent" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>ContentReferenceEvent</h2>
<p>Triggered when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain. Only GitHub Apps can receive this event. GitHub Apps that have the <code>content_references</code> <code>write</code> permission and subscribe to the <code>content_reference</code> event receive this webhook event when a new content reference is <code>created</code>. See &quot;<a href="/apps/using-content-attachments/">Using content attachments</a>&quot; to learn more about content references and attachments.</p>
<p>Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (<code>https://subdomain.example.com</code>) then only URLs for the subdomain trigger this event. If you register a domain (<code>https://example.com</code>) then URLs for domain and all subdomains trigger this event. See &quot;<a href="/v3/apps/#create-a-content-attachment">Create a content attachment</a>&quot; to create a new content attachment.</p>
<p>Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (<code>https://subdomain.example.com</code>) then only URLs for the subdomain trigger this event. If you register a domain (<code>https://example.com</code>) then URLs for domain and all subdomains trigger this event. See &quot;<a href="/v3/apps/installations/#create-a-content-attachment">Create a content attachment</a>&quot; to create a new content attachment.</p>
<h3>
<a id="webhook-event-name-3" class="anchor" href="#webhook-event-name-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Webhook event name</h3>
<p><code>content_reference</code></p>
@@ -1178,7 +1178,7 @@ <h2>

<p>Triggered when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain. Only GitHub Apps can receive this event. GitHub Apps that have the <code>content_references</code> <code>write</code> permission and subscribe to the <code>content_reference</code> event receive this webhook event when a new content reference is <code>created</code>. See "<a href="/apps/using-content-attachments/">Using content attachments</a>" to learn more about content references and attachments.</p>

<p>Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (<code>https://subdomain.example.com</code>) then only URLs for the subdomain trigger this event. If you register a domain (<code>https://example.com</code>) then URLs for domain and all subdomains trigger this event. See "<a href="/v3/apps/#create-a-content-attachment">Create a content attachment</a>" to create a new content attachment.</p>
<p>Webhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (<code>https://subdomain.example.com</code>) then only URLs for the subdomain trigger this event. If you register a domain (<code>https://example.com</code>) then URLs for domain and all subdomains trigger this event. See "<a href="/v3/apps/installations/#create-a-content-attachment">Create a content attachment</a>" to create a new content attachment.</p>

<h3>
<a id="webhook-event-name-3" class="anchor" href="#webhook-event-name-3" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Webhook event name</h3>
@@ -1,5 +1,5 @@
<h2>
<a id="content-references" class="anchor" href="#content-references" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Content References</h2>
<ul>
<li><a href="/v3/apps/#create-a-content-attachment">Create a content attachment</a></li>
<li><a href="/v3/apps/installations/#create-a-content-attachment">Create a content attachment</a></li>
</ul>
@@ -397,7 +397,7 @@ <h2>
<a id="content-references" class="anchor" href="#content-references" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Content References</h2>

<ul>
<li><a href="/v3/apps/#create-a-content-attachment">Create a content attachment</a></li>
<li><a href="/v3/apps/installations/#create-a-content-attachment">Create a content attachment</a></li>
</ul>

<h2>
@@ -0,0 +1,30 @@
<h2>
<a id="delete-an-installation" class="anchor" href="#delete-an-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Delete an installation</h2>
<div class="alert note">

<p><strong>Note:</strong> Unintalling GitHub Apps using the REST API is currently available for developers to preview. To access the new endpoint during the preview period, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> header:</p>

<pre><code>application/vnd.github.gambit-preview+json
</code></pre>

</div>
<div class="alert note">

<p><strong>Note:</strong> To access the API with your GitHub App, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> Header for your requests.</p>

<p><code>application/vnd.github.machine-man-preview+json</code></p>

</div>
<div class="alert warning">

<p><strong>Warning:</strong> The API may change without advance notice during the preview period. Preview features are not supported for production use. If you experience any issues, contact <a href="https://github.com/contact">GitHub Support</a>.</p>

</div>
<p>Uninstalls a GitHub App on a user, organization, or business account.</p>
<p>You must use a <a href="/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app">JWT</a> to access this endpoint.</p>
<pre><code>DELETE /app/installations/:installation_id
</code></pre>
<h3>
<a id="response-4" class="anchor" href="#response-4" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Response</h3>
<pre class="highlight highlight-headers"><code>Status: 204 No Content
</code></pre>
@@ -1,5 +1,5 @@
<h2>
<a id="find-repository-installation" class="anchor" href="#find-repository-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Find repository installation</h2>
<a id="get-a-repository-installation" class="anchor" href="#get-a-repository-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Get a repository installation</h2>
<div class="alert note">

<p><strong>Note:</strong> To access the API with your GitHub App, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> Header for your requests.</p>
@@ -1,5 +1,5 @@
<h2>
<a id="find-user-installation" class="anchor" href="#find-user-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Find user installation</h2>
<a id="get-a-user-installation" class="anchor" href="#get-a-user-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Get a user installation</h2>
<div class="alert note">

<p><strong>Note:</strong> To access the API with your GitHub App, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> Header for your requests.</p>
@@ -1,5 +1,5 @@
<h2>
<a id="get-a-single-installation" class="anchor" href="#get-a-single-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Get a single installation<a href="/apps/" class="tooltip-link github-apps-marker octicon octicon-info" title="Enabled for GitHub Apps"></a>
<a id="get-an-installation" class="anchor" href="#get-an-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Get an installation<a href="/apps/" class="tooltip-link github-apps-marker octicon octicon-info" title="Enabled for GitHub Apps"></a>
</h2>
<div class="alert note">

@@ -1,5 +1,5 @@
<h2>
<a id="find-organization-installation" class="anchor" href="#find-organization-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Find organization installation</h2>
<a id="get-an-organization-installation" class="anchor" href="#get-an-organization-installation" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Get an organization installation</h2>
<div class="alert note">

<p><strong>Note:</strong> To access the API with your GitHub App, you must provide a custom <a href="/v3/media">media type</a> in the <code>Accept</code> Header for your requests.</p>

0 comments on commit f66d4f5

Please sign in to comment.
You can’t perform that action at this time.