docs(provisioning): Clarify personal_api_key is now optional for most partners#17341
Open
inkeep[bot] wants to merge 1 commit into
Open
docs(provisioning): Clarify personal_api_key is now optional for most partners#17341inkeep[bot] wants to merge 1 commit into
inkeep[bot] wants to merge 1 commit into
Conversation
Reflects PR #61760 which gates PAT minting off by default. The personal_api_key response field is now only returned for partner apps with personal API key issuance explicitly enabled.
Contributor
Deploy preview
|
Contributor
|
Vale prose linter → found 0 errors, 16 warnings, 11 suggestions in your markdown Full report → Copy the linter results into an LLM to batch-fix issues. Linter being weird? Update the rules!
|
| Line | Severity | Message | Rule |
|---|---|---|---|
| 8:140 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 14:15 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 42:71 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 42:76 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 99:144 | warning | 'org's' is a possible misspelling. | PostHogBase.Spelling |
| 125:5 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 131:50 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 131:145 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 174:59 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 190:1 | suggestion | Address the reader directly. Use 'you' instead of 'The user'. | PostHogDocs.DirectAddress |
| 204:42 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 271:44 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 328:183 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 332:228 | warning | Capitalize 'Logs' for PostHog's product. Use 'logs' for the general industry concept. | PostHogBase.ProductNames |
| 332:233 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 344:224 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 362:199 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 424:34 | warning | Capitalize 'Experiments' for PostHog's product. Use 'experiments' for the general industry concept. | PostHogBase.ProductNames |
| 425:34 | warning | Capitalize 'Feature Flags' for PostHog's product. Use 'feature flags' for the general industry concept. | PostHogBase.ProductNames |
| 436:9 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 438:35 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
| 441:32 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 448:14 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 460:38 | warning | 'OAuth' is a possible misspelling. | PostHogBase.Spelling |
| 485:18 | warning | Capitalize 'Endpoints' for PostHog's product. Use 'endpoints' for the general industry concept. | PostHogBase.ProductNames |
| 499:20 | warning | Use 'PostHog' instead of 'posthog'. | Vale.Terms |
| 611:74 | suggestion | Address the reader directly. Use 'you' instead of 'the user'. | PostHogDocs.DirectAddress |
Contributor
|
Hey @MattBro! This docs PR was generated for you by an agent. You're responsible for reviewing and merging it into production.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Updates the Provisioning API documentation to reflect that the
personal_api_keyresponse field is now optional and only returned for grandfathered partner applications.What changed
Following PostHog/posthog#61760, PAT minting is now gated off by default for new partner applications:
provisioning_issues_personal_api_keyflag controls whether a partner app receives a personal API key during provisioningpersonal_api_keyDocumentation updates
personal_api_keyfrom the JSON example since most apps won't receive itpersonal_api_keyis only returned for apps with personal API key issuance enabledpersonal_api_keyis conditionalpersonalApiKeymay be undefinedThis PR was created by the Inkeep Content Writer agent, which is maintained by the Docs and Wizard team. Please reach out on Slack for help if needed.