Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 15, 2026

The /v1/node/new endpoint was undocumented in openapi.yaml despite being implemented in script/rvd_front.

Changes

  • Added POST /v1/node/new endpoint documentation with form parameters:
    • name: Node identifier
    • vm_type: Hypervisor type (KVM, LXC, Void)
    • hostname: FQDN or IP address
    • _submit: Form submission flag (must be 1)
  • Documented admin-only access requirement and response codes (200, 401, 400)
  • Used application/x-www-form-urlencoded content type matching the implementation

The endpoint creates a new hypervisor node by inserting parameters into the vms table via Ravada::Front->add_node().

Original prompt

This section details on the original issue you should resolve

<issue_title>Document API /v1/node/new</issue_title>
<issue_description>
Document in openapi.yaml the function for create a new node found in script/rvd_front

/v1/node/new

The POST arguments should be:

  • name : name of the new node
  • vm_type: type ( usually KVM )
  • hostname: fqdn or IP address
  • _submit: true value 1</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: frankiejol <136835+frankiejol@users.noreply.github.com>
Copilot AI changed the title [WIP] Document API for creating a new node in openapi.yaml Document /v1/node/new POST endpoint in OpenAPI specification Jan 15, 2026
Copilot AI requested a review from frankiejol January 15, 2026 11:09
@frankiejol frankiejol marked this pull request as ready for review January 15, 2026 11:29
Copilot AI review requested due to automatic review settings January 15, 2026 11:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This pull request adds OpenAPI documentation for the /v1/node/new endpoint that creates new hypervisor nodes in Ravada. The endpoint was previously implemented in script/rvd_front but undocumented in the OpenAPI specification.

Changes:

  • Added POST /v1/node/new endpoint documentation with request body schema
  • Documented required form parameters: name, vm_type, hostname, and _submit
  • Specified response codes and admin privilege requirements

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

frankiejol and others added 2 commits January 15, 2026 12:34
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@frankiejol frankiejol merged commit fc6bbf1 into main Jan 15, 2026
1 check passed
@frankiejol frankiejol deleted the copilot/document-api-v1-node-new branch January 16, 2026 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document API /v1/node/new

2 participants