Patched /tmp/tmpptoa8sbv/custom/test/hello/v1/test.js

Author: patched.codes[bot]

custom/test/hello/v1/test.js

@@ -5,7 +5,17 @@ import { sep } from 'path';
 const version = __dirname.split(sep).reverse()[0];
 const endpoint = `${version}/hello`;
 
+/**
+ * Test suite for the 'hello' endpoint
+ * @param {string} endpoint - The base URL of the hello endpoint
+ * @returns {void} No return value
+ */
 describe('hello:', () => {
+  /**
+   * Tests the GET request to the specified endpoint with a missing "name" query parameter
+   * @param {string} endpoint - The API endpoint being tested
+   * @returns {void} This test function doesn't return a value
+   */
   it(`GET ${endpoint} - missing "name" query parameter - returns 400`, async () => {
     const res = await request({
       method: 'GET',
@@ -15,6 +25,11 @@ describe('hello:', () => {
     expect(res.result.error).to.equal('"name" is required');
   });
 
+  /**
+   * Tests the GET request to the specified endpoint with a "name" query parameter
+   * @param {string} endpoint - The API endpoint to be tested
+   * @returns {void} This test function doesn't return a value
+   */
   it(`GET ${endpoint} - with "name" query parmeter - returns 200`, async () => {
     const res = await request({
       method: 'GET',
@@ -24,6 +39,11 @@ describe('hello:', () => {
     expect(res.result).to.toMatchObject({ hello: 'world' });
   });
 
+  /**
+   * Tests the GET request to {endpoint}/{name} for a 200 status code and correct response body
+   * @param {string} endpoint - The base endpoint URL for the API
+   * @returns {void} This test function does not return a value
+   */
   it(`GET ${endpoint}/{name} - returns 200`, async () => {
     const res = await request({
       method: 'GET',
@@ -33,6 +53,11 @@ describe('hello:', () => {
     expect(res.result).to.toMatchObject({ hello: 'world' });
   });
 
+  /**
+   * Tests the POST request to the specified endpoint
+   * @param {string} endpoint - The API endpoint to be tested
+   * @returns {void} This test function doesn't return a value
+   */
   it(`POST ${endpoint} - returns 201`, async () => {
     const res = await request({
       method: 'POST',
@@ -46,6 +71,11 @@ describe('hello:', () => {
     expect(res.result).to.toMatchObject({ hello: 'world' });
   });
 
+  /**
+   * Tests the PUT request to the specified endpoint with a name parameter
+   * @param {string} endpoint - The base endpoint for the API
+   * @returns {void} No return value
+   */
   it(`PUT ${endpoint}/{name} - returns 200`, async () => {
     const res = await request({
       method: 'PUT',
@@ -58,6 +88,11 @@ describe('hello:', () => {
     expect(res.result).to.toMatchObject({ hello: 'world', comment: 'hello' });
   });
 
+  /**
+   * Tests the DELETE endpoint for a specific name
+   * @param {string} endpoint - The base endpoint URL
+   * @returns {void} No return value
+   */
   it(`DELETE ${endpoint}/{name} - returns 200`, async () => {
     const res = await request({
       method: 'DELETE',