-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Dd dominic/update oauth doc #32317
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.
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
base: master
Are you sure you want to change the base?
Dd dominic/update oauth doc #32317
Conversation
…Dog/documentation into dd-dominic-update-oauth-doc
Preview links (active after the
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for adding the additional information and reorganizing the documentation! It looks great. I have a few suggestions.
|
|
||
| Note: This functionality is only available for approved Technology Partners intending on building integrations. OAuth clients for other purposes are not supported. | ||
| 1. Determine the required [scopes][8] for your integration use case. | ||
| 2. Implement OAuth following [these steps][9]. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 2. Implement OAuth following [these steps][9]. | |
| 2. [Implement OAuth][9]. |
| 5. Click **Generate OAuth Client Secret** to create credentials for testing. | ||
| 6. Record the client secret, as it is not displayed again. | ||
| 7. Select the minimum scopes required for your integration. | ||
| - **Note**: Enable the `api_keys_write` scope to submit data (metrics, logs, events, etc.) to Datadog. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - **Note**: Enable the `api_keys_write` scope to submit data (metrics, logs, events, etc.) to Datadog. | |
| - **Note**: Enable the `api_keys_write` scope to submit data (such as metrics, logs, or events) to Datadog. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks wayyyy better, thank you!
Commented with a couple style guide things, and then there's a stray link to a header that was removed from the doc.
| - Your product must be generally available | ||
| - Your product must host the source code that interacts with the Datadog API | ||
| - Your integration must submit telemetry to Datadog | ||
| - Your integration must implement OAuth for authorization (see below for more details) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| - Your product must be generally available | |
| - Your product must host the source code that interacts with the Datadog API | |
| - Your integration must submit telemetry to Datadog | |
| - Your integration must implement OAuth for authorization (see below for more details) | |
| - Your product must be generally available. | |
| - Your product must host the source code that interacts with the Datadog API. | |
| - Your integration must submit telemetry to Datadog. | |
| - Your integration must implement OAuth for authorization (see below for more details). |
| [2]: https://docs.datadoghq.com/api/latest/metrics/ | ||
| [3]: https://docs.datadoghq.com/logs/faq/partner_log_integration/ | ||
| [4]: https://docs.datadoghq.com/api/latest/events/ | ||
| [5]: https://docs.datadoghq.com/api/latest/incidents/ | ||
| [6]: https://docs.datadoghq.com/api/latest/users/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| [2]: https://docs.datadoghq.com/api/latest/metrics/ | |
| [3]: https://docs.datadoghq.com/logs/faq/partner_log_integration/ | |
| [4]: https://docs.datadoghq.com/api/latest/events/ | |
| [5]: https://docs.datadoghq.com/api/latest/incidents/ | |
| [6]: https://docs.datadoghq.com/api/latest/users/ | |
| [2]: /api/latest/metrics/ | |
| [3]: /logs/faq/partner_log_integration/ | |
| [4]: /api/latest/events/ | |
| [5]: /api/latest/incidents/ | |
| [6]: /api/latest/users/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(We use relative links to link to other pages published on the documentation site.)
|
|
||
| 2. Look for the API key named `OAuth Client API Key` and select it. | ||
| 3. Click **Revoke** to disable the API key. | ||
| 4. Follow the steps in [Create an API key](#create-an-api-key) to create a new key. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't in the doc anymore and I'm not totally sure what to replace it with -- it looks like there's a call during the OAuth handshake that creates the key? (The old section is also linked from under the Troubleshooting heading, could you update it there too?)
What does this PR do? What is the motivation?
Update documentation for technology partners to build API integrations with the new Developer Platform