-
Notifications
You must be signed in to change notification settings - Fork 34
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
Fixes #21223: Move create node doc in rudder core #906
Fixes #21223: Move create node doc in rudder core #906
Conversation
34fcd49
to
0245141
Compare
- status, | ||
- OS: type, name | ||
|
||
Other information are possible. See the https://docs.rudder.io/api/#tag/Create-Node[plugin API documentation] for more information. |
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.
change the URL for the API
|
||
=== Request format | ||
|
||
The plugin provides a new API endpoint: PUT `/api/latest/nodes` |
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.
Modify if we decide to use another URL
|
||
The plugin provides a new API endpoint: PUT `/api/latest/nodes` | ||
|
||
So for example, for curl: `curl -k -H "X-API-Token: 5YJnb4EenqDHzwx0U0eTPWWhgjTJ8mkk" -H "Content-Type: application/json" -X PUT 'https://your-server/rudder/api/latest/nodes' -d@/path/to/node.json` |
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.
here too
|
||
So for example, for curl: `curl -k -H "X-API-Token: 5YJnb4EenqDHzwx0U0eTPWWhgjTJ8mkk" -H "Content-Type: application/json" -X PUT 'https://your-server/rudder/api/latest/nodes' -d@/path/to/node.json` | ||
|
||
With "node.json" expected to be a JSON file with the following format: |
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.
If think we should just describe the goal and the general behavior of the feature here, API details should be a link to API docs.
PR updated with a new commit |
OK, squash merging this PR |
3072c35
to
fe983a1
Compare
https://issues.rudder.io/issues/21223