Reference · SemText · Definitions & citations

`<sem-api-param>`

SemText element

The child of sem-api-call. The in attribute says where the parameter lives (query, body, header, or response for a returned field); required marks the ones the caller must send.

Shares its schema with <sem-api-call> — the option bullets below belong to that element's contract.

One parameter row inside a sem-api-call: name, where it lives, type and description. The child of sem-api-call. The in attribute says where the parameter lives (query, body, header, or response for a returned field); required marks the ones the caller must send.

No options beyond the global attribute catalog are stated for this tag.

Example

sem-api-param.html

source

              
              <sem-api-call name="Create token" method="POST" endpoint="/oauth/token" status="200">
            
                Exchanges a grant for a token pair.
            
                <sem-api-param name="grant_type" in="body" type="string" required allowed="authorization_code,refresh_token">The grant to exchange.</sem-api-param>
            
                <sem-api-param name="code" in="body" type="string">The authorization code.</sem-api-param>
            
                <sem-api-param name="ttl" in="response" type="integer">Access-token lifetime in seconds.</sem-api-param>
            
              </sem-api-call>

render

Live render boots with JavaScript — the authored source is alongside.

Source: spec/schema/sem-api-call.md