1.0.4 • Published 1 year ago

@sfdocs-internal/api-body-document v1.0.4

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

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.

A component to render HTTP method body documentation based on AMF model generated from API spec file.

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-body-document

In an html file

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

In a LitElement

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

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

Development

git clone https://github.com/advanced-rest-client/api-body-document
cd api-body-document
npm install

Running the demo locally

npm start

Running the tests

npm test
api-componentsbody-documentation
@advanced-rest-client/arc-icons@advanced-rest-client/arc-marked@advanced-rest-client/markdown-styles@anypoint-web-components/anypoint-button@anypoint-web-components/anypoint-collapse@api-components/amf-helper-mixin@sfdocs-internal/api-resource-example-document@api-components/api-schema-document@sfdocs-internal/api-type-documentlit-elementlit-html
@infinitebrahmanuniverse/nolb-_sf@everything-registry/sub-chunk-826@sfdocs-internal/api-responses-document@sfdocs-internal/api-method-documentation
1.0.4

1 year ago

1.0.3-alpha

2 years ago

1.0.4-alpha1

1 year ago

1.0.4-alpha2

1 year ago

1.0.3-alpha1

2 years ago

1.0.4-alpha4

1 year ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.2-alpha8

2 years ago

1.0.2-alpha9

2 years ago

1.0.3

2 years ago

1.0.2-alpha10

2 years ago

1.0.2-alpha6

2 years ago

1.0.2-alpha7

2 years ago

1.0.2-alpha

2 years ago

1.0.2-alpha5

2 years ago

1.0.2-alpha2

2 years ago

1.0.2-alpha14

2 years ago

1.0.2-alpha3

2 years ago

1.0.2-alpha11

2 years ago

1.0.2-alpha12

2 years ago

1.0.2-alpha1

2 years ago

1.0.0-alpha1

2 years ago

1.0.0-alpha

2 years ago

1.0.0

2 years ago