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 docs.asciidoc #42722

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update docs.asciidoc #42722

wants to merge 1 commit into from

Conversation

BenedyMelo
Copy link

@BenedyMelo BenedyMelo commented Feb 14, 2025

Proposed commit message

Updated the description to include a note on the first setup required permissions. When testing this with a customer, the first setup thrown the following error:

2025-02-03T19:54:05.876Z ERROR [input.httpjson-cursor] v2/input.go:115 Error while processing http request: failed to execute http client.Do: server responded with status code 403: {"error":{"code":"Forbidden","message":"Missing application roles. API required roles: Incident.Read.All,Incident.ReadWrite.All, application roles:

So I added a pharagraph to make it clear that the first setup needs some permissions to access the file system.

There was no code changes.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Disruptive User Impact

Customer was not aware of the permissions the Integration should have.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

Updated the description to include a note on the first setup required permissions. When testing this with a customer, the first setup thrown the following error:

```
2025-02-03T19:54:05.876Z ERROR [input.httpjson-cursor] v2/input.go:115 Error while processing http request: failed to execute http client.Do: server responded with status code 403: {"error":{"code":"Forbidden","message":"Missing application roles. API required roles: Incident.Read.All,Incident.ReadWrite.All, application roles:
```
So I added a note to make it clear that the first setup needs some permissions to access the file system.
@BenedyMelo BenedyMelo requested a review from a team as a code owner February 14, 2025 20:30
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Feb 14, 2025
@botelastic
Copy link

botelastic bot commented Feb 14, 2025

This pull request doesn't have a Team:<team> label.

Copy link
Contributor

mergify bot commented Feb 14, 2025

This pull request does not have a backport label.
If this is a bug or security fix, could you label this PR @BenedyMelo? 🙏.
For such, you'll need to label your PR with:

  • The upcoming major version of the Elastic Stack
  • The upcoming minor version of the Elastic Stack (if you're not pushing a breaking change)

To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-8./d is the label to automatically backport to the 8./d branch. /d is the digit
  • backport-active-all is the label that automatically backports to all active branches.
  • backport-active-8 is the label that automatically backports to all active minor branches for the 8 major.
  • backport-active-9 is the label that automatically backports to all active minor branches for the 9 major.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs_team Indicates that the issue/PR needs a Team:* label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant