feat(cli): allow for overriding the path and method

Author: freakyfelt

README.md

@@ -390,8 +390,10 @@ paths:
     post:
       operationId: createWidget
       requestBody:
-        application/json:
-          schema: { $ref: '#/components/schemas/CreateWidgetInput' }
+        required: true
+        content:
+          application/json:
+            schema: { $ref: '#/components/schemas/CreateWidgetInput' }
       responses:
         201:
           description: Widget created without issue
@@ -403,17 +405,14 @@ paths:
 ```
 </details>
 
-### (TODO) Changing the HTTP method and URL
-
-> **Warning**
-> This is not yet implemented
+### Changing the HTTP method and URL
 
 By default parameters will end up in the default location (`query` for `query` operations and `requestBody` for `mutation` operations). You can use the keywords `method` and `path` to override the default HTTP method and resulting path respectively. You can even specify path parameters, though you will then need to override the parameters mappings.
 
 > **Note**
 > The YARPC operations can happily live alongside your standard [`paths` object][oas:paths-object] in the specification. The library will merge the resulting paths objects.
 
-For example, you may want to make a RESTful `modifyWidget` route that modifies a widget owned by a user in a RESTful manner:
+For example, you may want to make a RESTful `modifyWidget` route that modifies a widget in a RESTful manner:
 
 ```yaml
 operations:
@@ -448,11 +447,16 @@ paths:
       parameters:
         - name: widgetId
           in: path
-          schema: { $ref: '#/components/schemas/ModifyWidgetInput/properties/widgetId' }
+          schema: { $ref: '#/components/schemas/WidgetID' }
       requestBody:
         application/json:
-          // note the `Body` label appended to the end
-          schema: { $ref: '#/components/schemas/ModifyWidgetInputBody' }
+          schema:
+            type: object
+            required:
+              - userId
+            properties:
+              userId: { $ref: '#/components/schemas/UserID' }
+              ...
 ```
 </details>
 

packages/cli/src/transformers/document-transformer.test.ts

@@ -140,4 +140,42 @@ test("DocumentTransformer#transform", async (t) => {
 		const actual = await transformer.transform();
 		assert.deepStrictEqual(actual, oasDocument);
 	});
+
+	await t.test("override query method and path", async () => {
+		const doc = {
+			...rpcDocument,
+			operations: {
+				queries: {
+					deepHealthCheck: {
+						method: "post",
+						path: "/health/deep",
+
+						output: {
+							description: "No content",
+							statusCode: 204,
+						},
+					},
+				},
+			},
+		} as const;
+
+		const expected = {
+			...oasDocument,
+			paths: {
+				...oasDocument.paths,
+				"/health/deep": {
+					post: {
+						operationId: "deepHealthCheck",
+						responses: {
+							204: { description: "No content" },
+						},
+					},
+				},
+			},
+		};
+
+		const transformer = new DocumentTransformer(doc);
+		const actual = await transformer.transform();
+		assert.deepStrictEqual(actual, expected);
+	});
 });

packages/cli/src/transformers/document-transformer.ts

@@ -50,18 +50,24 @@ export class DocumentTransformer {
 	async rpcToPaths(rpc: RPCDocument["operations"]): Promise<PathsObject> {
 		const paths: PathsObject = {};
 
-		for (const [operationId, operation] of Object.entries(rpc.queries)) {
-			paths[`/queries/${operationId}`] = {
-				get: await this.transformer.transformQueryOperation(
+		for (const [operationId, operation] of Object.entries(rpc.queries ?? {})) {
+			const httpMethod = operation.method ?? "get";
+
+			paths[operation.path ?? `/queries/${operationId}`] = {
+				[httpMethod]: await this.transformer.transformQueryOperation(
 					operationId,
 					operation
 				),
 			};
 		}
 
-		for (const [operationId, operation] of Object.entries(rpc.mutations)) {
-			paths[`/mutations/${operationId}`] = {
-				post: await this.transformer.transformMutationOperation(
+		for (const [operationId, operation] of Object.entries(
+			rpc.mutations ?? {}
+		)) {
+			const httpMethod = operation.method ?? "post";
+
+			paths[operation.path ?? `/mutations/${operationId}`] = {
+				[httpMethod]: await this.transformer.transformMutationOperation(
 					operationId,
 					operation
 				),