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.

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

Update examples for correct endUserNotification schema when creating Attack Simulation #9471

Merged
merged 10 commits into from
Dec 3, 2024

Conversation

jonade
Copy link
Contributor

@jonade jonade commented Nov 26, 2024

Important

Required for API changes:

  • Link to API.md file: ADD LINK HERE
  • Link to PR for public-facing schema changes (schema-Prod-beta/v1.0.csdl): ADD LINK HERE

The examples provided on this page (https://learn.microsoft.com/en-us/graph/api/attacksimulationroot-post-simulation?view=graph-rest-beta&tabs=http) result in errors due to the endUserNotification being provided in a format that is not expected.

Using the existing example for endUserNotification results in an error:
image

Update the example to use the [email protected] format instead, which does not generate an error:
image


Important

The following guidance is for Microsoft employees only. Community contributors can ignore this message; our content team will manage the status.

After you've created your PR, expand this section for tips and additional instructions.
  • do not merge is the default PR status and is automatically added to all open PRs that don't have the ready to merge label.
  • Add the ready for content review label to start a review. Only PRs that have met the minimum requirements for content review and have this label are reviewed.
  • If your content reviewer requests changes, review the feedback and address accordingly as soon as possible to keep your pull request moving forward. After you address the feedback, remove the changes requested label, add the review feedback addressed label, and select the Re-request review icon next to the content reviewer's alias. If you can't add labels, add a comment with #feedback-addressed to the pull request.
  • After the content review is complete, your reviewer will add the content review complete label. When the updates in this PR are ready for external customers to use, replace the do not merge label with ready to merge and the PR will be merged within 24 working hours.
  • Pull requests that are inactive for more than 6 weeks will be automatically closed. Before that, you receive reminders at 2 weeks, 4 weeks, and 6 weeks. If you still need the PR, you can reopen or recreate the request.

For more information, see the Content review process summary.

Copy link

Learn Build status updates of commit a7ca178:

💡 Validation status: suggestions

File Status Preview URL Details
api-reference/beta/api/attacksimulationroot-post-simulation.md 💡Suggestion Details
api-reference/beta/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded

api-reference/beta/api/attacksimulationroot-post-simulation.md

  • Line 2, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@jonade jonade changed the title Update examples for correct endUserNotification schema Update examples for correct endUserNotification schema when creating Attack Simulation Nov 26, 2024
Copy link

Learn Build status updates of commit 12d1c4a:

💡 Validation status: suggestions

File Status Preview URL Details
api-reference/beta/api/attacksimulationroot-post-simulation.md 💡Suggestion Details
api-reference/v1.0/api/attacksimulationroot-post-simulation.md 💡Suggestion Details
api-reference/beta/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded
api-reference/v1.0/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded

api-reference/beta/api/attacksimulationroot-post-simulation.md

  • Line 2, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.

api-reference/v1.0/api/attacksimulationroot-post-simulation.md

  • Line 2, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link

Learn Build status updates of commit 6f3893e:

💡 Validation status: suggestions

File Status Preview URL Details
api-reference/beta/api/attacksimulationroot-post-simulation.md 💡Suggestion Details
api-reference/v1.0/api/attacksimulationroot-post-simulation.md 💡Suggestion Details
api-reference/beta/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded
api-reference/v1.0/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded

api-reference/beta/api/attacksimulationroot-post-simulation.md

  • Line 2, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.

api-reference/v1.0/api/attacksimulationroot-post-simulation.md

  • Line 2, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@JarbasHorst JarbasHorst self-assigned this Dec 1, 2024
@JarbasHorst JarbasHorst added the content review complete Apply when the content review is complete on a PR. label Dec 1, 2024
@JarbasHorst
Copy link
Contributor

Hello @jonade, snippet files are generated automatically, so can't modify them.

Copy link

Learn Build status updates of commit 0807950:

💡 Validation status: suggestions

File Status Preview URL Details
api-reference/beta/api/attacksimulationroot-post-simulation.md 💡Suggestion Details
api-reference/beta/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded
api-reference/v1.0/api/attacksimulationroot-post-simulation.md ✅Succeeded
api-reference/v1.0/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded

api-reference/beta/api/attacksimulationroot-post-simulation.md

  • Line 2, Column 1: [Suggestion: ms-date-missing - See documentation] Missing required attribute: 'ms.date'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Copy link

Learn Build status updates of commit a758a1f:

✅ Validation status: passed

File Status Preview URL Details
api-reference/beta/api/attacksimulationroot-post-simulation.md ✅Succeeded
api-reference/beta/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded
api-reference/v1.0/api/attacksimulationroot-post-simulation.md ✅Succeeded
api-reference/v1.0/includes/snippets/powershell/create-simulations-powershell-snippets.md ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

@Lauragra Lauragra merged commit d7952c2 into microsoftgraph:main Dec 3, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug: documentation content review complete Apply when the content review is complete on a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants