From d74d7a820eb6d51dcd0e31981c0e8478d8e0d088 Mon Sep 17 00:00:00 2001 From: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> Date: Tue, 13 Aug 2024 09:40:32 -0700 Subject: [PATCH 1/2] fix: edit messages --- messages/rest.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/messages/rest.md b/messages/rest.md index 44277374..8a958528 100644 --- a/messages/rest.md +++ b/messages/rest.md @@ -1,27 +1,24 @@ # summary -Makes an authenticated HTTP request to the Salesforce REST API and prints the response. +Make an authenticated HTTP request to Salesforce REST API and print the response. -# description +# examples -You must specify a Salesforce org to use, either with the --target-org flag or by setting your default org with -the `target-org` configuration variable. +- List information about limits in the org with alias "my-org": -# examples + <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org + +- Get the response in XML format by specifying the "Accept" HTTP header: -- List information about limits in your org <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' - --target-org my-org -- Get response in XML format by specifying the "Accept" HTTP header: - <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org --header 'Accept: - application/xml', + <%= config.bin %> <%= command.id %> 'services/data/v56.0/limits' --target-org my-org --header 'Accept: application/xml', # flags.include.summary -Include HTTP response status and headers in the output. +Include the HTTP response status and headers in the output. # flags.method.summary -The HTTP method for the request. +HTTP method for the request. # flags.header.summary @@ -29,8 +26,8 @@ HTTP header in "key:value" format. # flags.stream-to-file.summary -Stream responses to file. +Stream responses to a file. # flags.body.summary -The file to use as the body for the request (use "-" to read from standard input, use "" for an empty body). +File to use as the body for the request. Specify "-" to read from standard input; specify "" for an empty body. From 2a36ce19afcc83a92f2018a305d1656e71b3422c Mon Sep 17 00:00:00 2001 From: Juliet Shackell <63259011+jshackell-sfdc@users.noreply.github.com> Date: Tue, 13 Aug 2024 09:41:30 -0700 Subject: [PATCH 2/2] fix: remove command description --- src/commands/org/api/rest.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/commands/org/api/rest.ts b/src/commands/org/api/rest.ts index 74aacc60..21ec0b0f 100644 --- a/src/commands/org/api/rest.ts +++ b/src/commands/org/api/rest.ts @@ -19,7 +19,6 @@ const messages = Messages.loadMessages('@salesforce/plugin-org', 'rest'); export class Rest extends SfCommand { public static readonly summary = messages.getMessage('summary'); - public static readonly description = messages.getMessage('description'); public static readonly examples = messages.getMessages('examples'); public static readonly hidden = true; public static enableJsonFlag = false;