@api-components/api-security-documentation
Advanced tools
Documentation view for AMF security description
This component is being deprecated. The code base has been moved to amf-components module. This module will be archived when PR 1 is merged.
Documentation view for AMF security model of an API.
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-security-documentation
The component requires to set 2 properties: amf and security.
The amf property is the whole API model generated by the AMF parser. This property is used to resolve compact moodel's keys.
The security property is the part of the API model describing security method. The shape type is http://a.ml/vocabularies/security#SecurityScheme.
<html>
<head>
<script type="module">
import '@api-components/api-security-documentation/api-security-documentation.js';
</script>
</head>
<body>
<api-security-documentation amf="..." security="..."></api-security-documentation>
</body>
</html>
import { LitElement, html } from 'lit-element';
import '@api-components/api-security-documentation/api-security-documentation.js';
class SampleElement extends PolymerElement {
static get properties() {
return {
// AMF model for selected security
security: { type: Object }
};
}
render() {
return html`
<api-security-documentation .amf="${this.amf}" .security="${this.security}"></api-security-documentation>
`;
}
}
customElements.define('sample-element', SampleElement);
git clone https://github.com/advanced-rest-client/api-security-documentation
cd api-security-documentation
npm install
npm start
npm test
FAQs
Documentation view for AMF security description
We found that @api-components/api-security-documentation 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
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.
Research
Security News
Eight new malicious Firefox extensions impersonate games, steal OAuth tokens, hijack sessions, and exploit browser permissions to spy on users.
Security News
The official Go SDK for the Model Context Protocol is in development, with a stable, production-ready release expected by August 2025.