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

Fixes #21223: Move create node doc in rudder core #906

Conversation

ElaadF
Copy link
Member

@ElaadF ElaadF commented Jun 6, 2022

@ElaadF ElaadF force-pushed the arch_21223/move_create_node_api_doc_in_rudder_core branch from 34fcd49 to 0245141 Compare June 6, 2022 14:03
- status,
- OS: type, name

Other information are possible. See the https://docs.rudder.io/api/#tag/Create-Node[plugin API documentation] for more information.
Copy link
Member Author

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`
Copy link
Member Author

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`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

here too

@ElaadF ElaadF requested a review from amousset June 6, 2022 14:07

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:
Copy link
Member

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.

@ElaadF ElaadF changed the title Fixes #21223: Move create node api doc in rudder core Fixes #21223: Move create node doc in rudder core Jun 6, 2022
@ElaadF
Copy link
Member Author

ElaadF commented Jun 6, 2022

PR updated with a new commit

@Normation-Quality-Assistant
Copy link
Contributor

OK, squash merging this PR

@Normation-Quality-Assistant Normation-Quality-Assistant force-pushed the arch_21223/move_create_node_api_doc_in_rudder_core branch from 3072c35 to fe983a1 Compare June 17, 2022 08:02
@Normation-Quality-Assistant Normation-Quality-Assistant merged commit fe983a1 into Normation:master Jun 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants