@sfdocs-internal/api-parameters-document NPM

DEPRECATED

This component is being deprecated. The code base has been moved to api-documentation module. This module will be archived when PR 37 is merged.

Documentation component for API query and URI parameters based on AMF data model.

Version compatibility

This version only works with AMF model version 2 (AMF parser >= 4.0.0). For compatibility with previous model version use 3.x.x version of the component.

Usage

Installation

npm install --save @api-components/api-parameters-document

In an html file

<html>
  <head>
    <script type="module">
      import '@api-components/api-parameters-document/api-parameters-document.js';
    </script>
  </head>
  <body>
    <api-parameters-document></api-parameters-document>
  </body>
</html>

import { LitElement, html } from 'lit-element';
import '@api-components/api-parameters-document/api-parameters-document.js';

class SampleElement extends PolymerElement {
  render() {
    return html`
    <api-parameters-document .amf="${this.amf}"></api-parameters-document>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Development

git clone https://github.com/api-components/api-parameters-document
cd api-parameters-document
npm install

Running the demo locally

npm start

Running the tests

npm test

api-components documentation parameters query-parameter path-parameter uri-parameter

@advanced-rest-client/arc-icons @anypoint-web-components/anypoint-button @anypoint-web-components/anypoint-collapse @sfdocs-internal/api-type-document lit-element lit-html

@infinitebrahmanuniverse/nolb-_sf @everything-registry/sub-chunk-826 @sfdocs-internal/api-security-documentation @sfdocs-internal/api-endpoint-documentation @sfdocs-internal/api-method-documentation

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago