chore: default to services/data/vXX.0

Author: WillieRuemmele

src/commands/api/request/rest.ts

@@ -25,6 +25,7 @@ export class Rest extends SfCommand<void> {
   public static enableJsonFlag = false;
   public static readonly flags = {
     'target-org': Flags.requiredOrg(),
+    'api-version': Flags.orgApiVersion(),
     include: Flags.boolean({
       char: 'i',
       summary: messages.getMessage('flags.include.summary'),
@@ -70,7 +71,14 @@ export class Rest extends SfCommand<void> {
     const streamFile = flags['stream-to-file'];
     const headers = flags.header ? getHeaders(flags.header) : {};
 
-    const url = new URL(`${org.getField<string>(Org.Fields.INSTANCE_URL)}/${args.endpoint}`);
+    // replace first '/' to create valid URL
+    const endpoint = args.endpoint.startsWith('/') ? args.endpoint.replace('/', '') : args.endpoint;
+    const url = new URL(
+      `${org.getField<string>(Org.Fields.INSTANCE_URL)}/services/data/v${
+        flags['api-version'] ?? (await org.retrieveMaxApiVersion())
+      }/${endpoint}`
+    );
+
     const body =
       flags.method === 'GET'
         ? undefined

test/commands/api/request/rest.nut.ts

@@ -48,15 +48,14 @@ skipIfWindows('api:request:rest NUT', () => {
 
   describe('std out', () => {
     it('get result in json format', () => {
-      const result = execCmd("api request rest 'services/data/v60.0/limits'").shellOutput.stdout;
+      const result = execCmd("api request rest 'limits'").shellOutput.stdout;
 
       // make sure we got a JSON object back
       expect(Object.keys(JSON.parse(result) as Record<string, unknown>)).to.have.length;
     });
 
     it('should pass headers', () => {
-      const result = execCmd("api request rest 'services/data/v60.0/limits' -H 'Accept: application/xml'").shellOutput
-        .stdout;
+      const result = execCmd("api request rest 'limits' -H 'Accept: application/xml'").shellOutput.stdout;
 
       // the headers will change this to xml
       expect(result.startsWith('<?xml version="1.0" encoding="UTF-8"?><LimitsSnapshot>')).to.be.true;
@@ -65,8 +64,7 @@ skipIfWindows('api:request:rest NUT', () => {
 
   describe('stream-to-file', () => {
     it('get result in json format', () => {
-      const result = execCmd("api request rest 'services/data/v60.0/limits' --stream-to-file out.txt").shellOutput
-        .stdout;
+      const result = execCmd("api request rest 'limits' --stream-to-file out.txt").shellOutput.stdout;
 
       expect(result.trim()).to.equal('File saved to out.txt');
 
@@ -76,9 +74,8 @@ skipIfWindows('api:request:rest NUT', () => {
     });
 
     it('should pass headers', () => {
-      const result = execCmd(
-        "api request rest 'services/data/v60.0/limits' -H 'Accept: application/xml'  --stream-to-file out.txt"
-      ).shellOutput.stdout;
+      const result = execCmd("api request rest 'limits' -H 'Accept: application/xml'  --stream-to-file out.txt")
+        .shellOutput.stdout;
 
       expect(result.trim()).to.equal('File saved to out.txt');
 

test/commands/api/request/rest.test.ts

@@ -43,14 +43,22 @@ describe('rest', () => {
   it('should request org limits and default to "GET" HTTP method', async () => {
     nock(testOrg.instanceUrl).get('/services/data/v56.0/limits').reply(200, orgLimitsResponse);
 
-    await Rest.run(['services/data/v56.0/limits', '--target-org', '[email protected]']);
+    await Rest.run(['--api-version', '56.0', 'limits', '--target-org', '[email protected]']);
+
+    expect(uxStub.styledJSON.args[0][0]).to.deep.equal(orgLimitsResponse);
+  });
+
+  it("should strip leading '/'", async () => {
+    nock(testOrg.instanceUrl).get('/services/data/v56.0/limits').reply(200, orgLimitsResponse);
+
+    await Rest.run(['--api-version', '56.0', '/limits', '--target-org', '[email protected]']);
 
     expect(uxStub.styledJSON.args[0][0]).to.deep.equal(orgLimitsResponse);
   });
 
   it('should throw error for invalid header args', async () => {
     try {
-      await Rest.run(['services/data/v56.0/limits', '--target-org', '[email protected]', '-H', 'myInvalidHeader']);
+      await Rest.run(['limits', '--target-org', '[email protected]', '-H', 'myInvalidHeader']);
       assert.fail('the above should throw');
     } catch (e) {
       expect((e as SfError).name).to.equal('Failed To Parse HTTP Header');
@@ -64,7 +72,15 @@ describe('rest', () => {
   it('should redirect to file', async () => {
     nock(testOrg.instanceUrl).get('/services/data/v56.0/limits').reply(200, orgLimitsResponse);
     const writeSpy = $$.SANDBOX.stub(process.stdout, 'write');
-    await Rest.run(['services/data/v56.0/limits', '--target-org', '[email protected]', '--stream-to-file', 'myOutput.txt']);
+    await Rest.run([
+      '--api-version',
+      '56.0',
+      'limits',
+      '--target-org',
+      '[email protected]',
+      '--stream-to-file',
+      'myOutput.txt',
+    ]);
 
     // gives it a second to resolve promises and close streams before we start asserting
     await sleep(1000);
@@ -93,10 +109,20 @@ describe('rest', () => {
         accept: 'application/xml',
       },
     })
-      .get('/services/data')
+      .get('/services/data/v42.0/')
       .reply(200, xmlRes);
 
-    await Rest.run(['services/data', '--header', 'Accept: application/xml', '--target-org', '[email protected]']);
+    await Rest.run([
+      '',
+      '--api-version',
+      '42.0',
+      '--method',
+      'GET',
+      '--header',
+      'Accept: application/xml',
+      '--target-org',
+      '[email protected]',
+    ]);
 
     const output = stripAnsi(writeSpy.args.flat().join(''));
 
@@ -126,7 +152,7 @@ describe('rest', () => {
         location: `${testOrg.instanceUrl}/services/data/v56.0/limits`,
       });
 
-    await Rest.run(['services/data/v56.0/limites', '--target-org', '[email protected]']);
+    await Rest.run(['limites', '--api-version', '56.0', '--target-org', '[email protected]']);
 
     expect(uxStub.styledJSON.args[0][0]).to.deep.equal(orgLimitsResponse);
   });