diff --git a/CHANGELOG.md b/CHANGELOG.md index 48ac5aee..fae32501 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,13 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +### [1.0.5](https://github.com/salesforcecli/plugin-schema/compare/v1.0.4...v1.0.5) (2021-04-01) + + +### Bug Fixes + +* leif .yml merge [skip-validate-pr] ([95bb8e0](https://github.com/salesforcecli/plugin-schema/commit/95bb8e0014ff5df3c6f59aa701762732b9a5c568)) + ### [1.0.4](https://github.com/salesforcecli/plugin-schema/compare/v1.0.3...v1.0.4) (2021-02-19) ### [1.0.3](https://github.com/salesforcecli/plugin-schema/compare/v1.0.2...v1.0.3) (2020-12-17) diff --git a/README.md b/README.md index 1fbec4a4..8e364aa4 100644 --- a/README.md +++ b/README.md @@ -69,78 +69,72 @@ sfdx plugins ## Commands +* [`sfdx force:schema:sobject:describe -s [-t] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceschemasobjectdescribe--s-string--t--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) +* [`sfdx force:schema:sobject:list [-c ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-forceschemasobjectlist--c-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal) -- [`sfdx force:schema:sobject:describe -s [-t] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`] +## `sfdx force:schema:sobject:describe -s [-t] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` -describe an sobject in your org +displays the metadata for a standard or custom object ``` USAGE - $ sfdx force:schema:sobject:describe -s [-t] [-u ] [--apiversion ] [--json] - [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] + $ sfdx force:schema:sobject:describe -s [-t] [-u ] [--apiversion ] [--json] [--loglevel + trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -s, --sobjecttype=sobjecttype (required) the API name of - the object to describe + -s, --sobjecttype=sobjecttype (required) the API name of the + object to describe -t, --usetoolingapi execute with Tooling API - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - --apiversion=apiversion override the api version - used for api requests made - by this command + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation - Examples: - $ sfdx force:schema:sobject:describe -s Account - $ sfdx force:schema:sobject:describe -s MyObject__c - $ sfdx force:schema:sobject:describe -s ApexClass -t +EXAMPLES + sfdx force:schema:sobject:describe -s Account + sfdx force:schema:sobject:describe -s MyObject__c + sfdx force:schema:sobject:describe -s ApexClass -t ``` -- [`sfdx force:schema:sobject:list -c [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`] +_See code: [src/commands/force/schema/sobject/describe.ts](https://github.com/salesforcecli/plugin-schema/blob/v1.0.4/src/commands/force/schema/sobject/describe.ts)_ + +## `sfdx force:schema:sobject:list [-c ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]` list all objects of a specified category ``` USAGE - $ sfdx force:schema:sobject:list -c [-u ] [--apiversion ] [--json] [--loglevel + $ sfdx force:schema:sobject:list [-c ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] OPTIONS - -c, --sobjecttypecategory=sobjecttypecategory (required) the type of - objects to list - (all|custom|standard) + -c, --sobjecttypecategory=sobjecttypecategory [default: ALL] the type of objects + to list (all|custom|standard) - -u, --targetusername=targetusername username or alias for the - target org; overrides - default target org + -u, --targetusername=targetusername username or alias for the target + org; overrides default target org - --apiversion=apiversion override the api version - used for api requests made - by this command + --apiversion=apiversion override the api version used for + api requests made by this command --json format output as json - --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging - level for this command - invocation - - Lists all objects, custom objects, or standard objects in the org. - - Examples: - $ sfdx force:schema:sobject:list -c all - $ sfdx force:schema:sobject:list -c custom - $ sfdx force:schema:sobject:list -c standard - + --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for + this command invocation +EXAMPLES + sfdx force:schema:sobject:list -c all + sfdx force:schema:sobject:list -c custom + sfdx force:schema:sobject:list -c standard ``` +_See code: [src/commands/force/schema/sobject/list.ts](https://github.com/salesforcecli/plugin-schema/blob/v1.0.4/src/commands/force/schema/sobject/list.ts)_ diff --git a/package.json b/package.json index ca3f444b..978fd5cb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@salesforce/plugin-schema", "description": "Commands to interact with salesforce sobject schemas", - "version": "1.0.4", + "version": "1.0.5", "author": "Salesforce", "bugs": "https://github.com/forcedotcom/cli/issues", "dependencies": {