@api-components/api-annotation-document
Advanced tools
Readme
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.
An element to render RAML annotations based on AMF data model.
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.
npm install --save @api-components/api-annotation-document
The element requires to set the amf property with the full generated AMF model to properly resolve compact JSON model. It also requires to set the shape property to whatever API property being currently documented (endpoint, method, type (including properties of a type which is also a type), security, security settings, and so on).
<html>
<head>
<script type="module">
import '@api-components/api-annotation-document/api-annotation-document.js';
</script>
</head>
<body>
<api-annotation-document></api-annotation-document>
<script>
{
const model = await getAmfModelSomehow();
const shape = computeCurrentShape(model, someId);
const aad = document.querySelector('api-annotation-document');
aad.amf = model;
aad.shape = shape;
}
</script>
</body>
</html>
import { LitElement, html } from 'lit-element';
import '@api-components/api-annotation-document/api-annotation-document.js';
class SampleElement extends LitElement {
render() {
return html`
<api-annotation-document
.amf="${this.model}"
.shape="${this.shape}"
></api-annotation-document>
`;
}
}
customElements.define('sample-element', SampleElement);
git clone https://github.com/advanced-rest-client/api-annotation-document
cd api-annotation-document
npm install
npm start
npm test
FAQs
An element to render RAML annotations based on AMF data model
We found that @api-components/api-annotation-document demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.