Skip to content

Commit

Permalink
Merge pull request #1175 from salesforcecli/js/edit-messages-org-api-…
Browse files Browse the repository at this point in the history
…rest

edit messages of "org api rest"
  • Loading branch information
WillieRuemmele authored Aug 13, 2024
2 parents 8f52788 + 2a36ce1 commit 08872b2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 15 deletions.
25 changes: 11 additions & 14 deletions messages/rest.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,33 @@
# 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

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.
1 change: 0 additions & 1 deletion src/commands/org/api/rest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ const messages = Messages.loadMessages('@salesforce/plugin-org', 'rest');

export class Rest extends SfCommand<void> {
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;
Expand Down

0 comments on commit 08872b2

Please sign in to comment.