chore: test alternative query param generation

[bencromwell]

Jane's current version uses

return sprintf(' *     @var %s $%s %s', $type, $parameter->getName(), $parameter->getDescription() ?: '');

This changes it to use

return sprintf(
            ' *      \'%s\': %s,%s',
            $parameter->getName(),
            $type,
            $parameter->getDescription() ? ' ' . $parameter->getDescription() : ''
        );

The result is in the diff of this PR, a representative sample is:

    /*
     * @param array $queryParameters {
     *
     * @var string $certificate[id] All 'certificate[]' params are mutually exclusive, only one can be provided.
     *             }
     */

which becomes

   /*
     * @param array $queryParameters {
     *                               'certificate[id]': string, All 'certificate[]' params are mutually exclusive, only one can be provided.
     *                               }
     */

[github-actions]

Download Reports

Download the OpenAPI Changes Report

Core API Changes

├─┬Paths
│ ├──[➕] path (7441:5)
│ ├──[➕] path (7770:5)
│ ├──[➕] path (1220:5)
│ ├─┬/organizations/organization/virtual_machines/build
│ │ └─┬POST
│ │   ├─┬Responses
│ │   │ └─┬422
│ │   │   └─┬application/json
│ │   │     └─┬Schema
│ │   │       └──[🔀] $ref (16690:18)❌ 
│ │   └─┬Requestbody
│ │     └─┬application/json
│ │       └─┬Schema
│ │         └──[➕] properties (11237:19)
│ └─┬/virtual_machine_packages
│   └─┬GET
│     └─┬Responses
│       └─┬200
│         └─┬application/json
│           └─┬Schema
│             └─┬virtual_machine_packages
│               └─┬Schema
│                 └──[🔀] $ref (15551:17)❌ 
└─┬Components
  ├──[➖] responses (20905:48)❌ 
  ├──[➕] responses (21301:69)
  ├──[➕] responses (20911:69)
  ├──[➕] responses (20921:33)
  ├──[➖] schemas (16587:44)❌ 
  ├──[➖] schemas (16550:69)❌ 
  ├──[➖] schemas (16281:53)❌ 
  ├──[➕] schemas (13055:42)
  ├──[➕] schemas (12755:36)
  ├──[➕] schemas (16689:74)
  ├──[➕] schemas (13070:42)
  ├──[➕] schemas (16674:38)
  ├──[➕] schemas (15604:37)
  ├──[➕] schemas (16668:36)
  ├──[➕] schemas (13041:36)
  ├──[➕] schemas (16407:43)
  ├──[➕] schemas (13076:44)
  ├──[➕] schemas (13091:74)
  ├──[➕] schemas (12805:35)
  ├──[➕] schemas (13049:40)
  ├──[➕] schemas (13101:29)
  ├─┬GetDiskTemplate200ResponseDiskTemplate
  │ └──[➕] properties (14957:11)
  ├─┬VirtualMachinePackage
  │ └──[➕] properties (15592:11)
  ├─┬DiskTemplate
  │ └──[➕] properties (13468:11)
  └─┬GetOrganizationDiskTemplates200ResponseDiskTemplates
    └──[➕] properties (14848:11)

Document Element	Total Changes	Breaking Changes
paths	6	2
components	25	4

Date: 09/04/24 | Commit: New: katapult-core-openapi.json, Original: /tmp/katapult-core-openapi.json

• ❌ BREAKING Changes: 6 out of 31
• Modifications: 2
• Removals: 4
• Additions: 25
• Breaking Removals: 4
• Breaking Modifications: 2

ERROR: breaking changes discovered

Public API Changes

└─┬Components
  ├──[➕] schemas (742:37)
  └─┬VirtualMachinePackage
    └──[➕] properties (707:11)

Document Element	Total Changes	Breaking Changes
components	2	0

Date: 09/04/24 | Commit: New: katapult-public-openapi.json, Original: /tmp/katapult-public-openapi.json

• Total Changes: 2
• Additions: 2