Skip to content

Commit

Permalink
docs: update smapi docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ask-cli committed Aug 25, 2020
1 parent 4d91056 commit 73a1646
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/concepts/Smapi-Command.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ The path params
| Add an id to the private distribution accounts. | [set-private-distribution-account-id](#set-private-distribution-account-id) |
| Remove an id from the private distribution accounts. | [delete-private-distribution-account-id](#delete-private-distribution-account-id) |
| List private distribution accounts. | [list-private-distribution-accounts](#list-private-distribution-accounts) |
| If the skill is in certified stage, initiate publishing immediately or set a date at which the skill can publish at. | [publish-skill](#publish-skill) |
| Retrieves the latest skill publishing details of the certified stage of the skill. The publishesAtDate and
status of skill publishing. | [get-skill-publications](#get-skill-publications) |
| This is an asynchronous API that simulates a skill execution in the Alexa eco-system given an utterance text of what a customer would say to Alexa. A successful response will contain a header with the location of the simulation resource. In cases where requests to this API results in an error, the response will contain an error code and a description of the problem. The skill being simulated must belong to and be enabled by the user of this API. Concurrent requests per user is currently not supported. | [simulate-skill](#simulate-skill) |
| This API gets the result of a previously executed simulation. A successful response will contain the status of the executed simulation. If the simulation successfully completed, the response will also contain information related to skill invocation. In cases where requests to this API results in an error, the response will contain an error code and a description of the problem. In cases where the simulation failed, the response will contain a status attribute indicating that a failure occurred and details about what was sent to the skill endpoint. Note that simulation results are stored for 10 minutes. A request for an expired simulation result will return a 404 HTTP status code. | [get-skill-simulation](#get-skill-simulation) |
| This is an asynchronous API which allows a skill developer to execute various validations against their skill. | [submit-skill-validation](#submit-skill-validation) |
Expand Down Expand Up @@ -2541,6 +2544,55 @@ List private distribution accounts.
<dd markdown="span">Enables the ASK CLI to show debug messages in the output of the command.</dd>
</dl>

### publish-skill

If the skill is in certified stage, initiate publishing immediately or set a date at which the skill can publish at.

`publish-skill` command format:

`$ ask smapi publish-skill <-s|--skill-id <skill-id>> <--accept-language <accept-language>> [--publishes-at-date <publishes-at-date>] [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
<dt>-s,--skill-id <skill-id></dt>
<dd markdown="span">[REQUIRED] The skill ID.</dd>
<dt>--accept-language <accept-language></dt>
<dd markdown="span">[REQUIRED] User's locale/language in context.</dd>
<dt>--publishes-at-date <publishes-at-date></dt>
<dd markdown="span">[OPTIONAL] Used to determine when the skill Publishing should start. It takes the request timestamp as default value. The date range can be a maximum of upto 6 months from the current time stamp. The format should be the RFC 3399 variant of ISO 8601. e.g 2019-04-12T23:20:50.52Z.</dd>
<dt>-p, --profile <profile></dt>
<dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
<dt>--full-response</dt>
<dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
<dt>--debug</dt>
<dd markdown="span">Enables the ASK CLI to show debug messages in the output of the command.</dd>
</dl>

### get-skill-publications

Retrieves the latest skill publishing details of the certified stage of the skill. The publishesAtDate and
status of skill publishing.

`get-skill-publications` command format:

`$ ask smapi get-skill-publications <-s|--skill-id <skill-id>> <--accept-language <accept-language>> [-p| --profile <profile>] [--full-response] [--debug]`

**Options**

<dl>
<dt>-s,--skill-id <skill-id></dt>
<dd markdown="span">[REQUIRED] The skill ID.</dd>
<dt>--accept-language <accept-language></dt>
<dd markdown="span">[REQUIRED] User's locale/language in context.</dd>
<dt>-p, --profile <profile></dt>
<dd markdown="span">Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.</dd>
<dt>--full-response</dt>
<dd markdown="span">Returns body, headers and status code of the response as one object.</dd>
<dt>--debug</dt>
<dd markdown="span">Enables the ASK CLI to show debug messages in the output of the command.</dd>
</dl>

### simulate-skill

This is an asynchronous API that simulates a skill execution in the Alexa eco-system given an utterance text of what a customer would say to Alexa. A successful response will contain a header with the location of the simulation resource. In cases where requests to this API results in an error, the response will contain an error code and a description of the problem. The skill being simulated must belong to and be enabled by the user of this API. Concurrent requests per user is currently not supported.
Expand Down

0 comments on commit 73a1646

Please sign in to comment.