Gathering detailed insights and metrics for @api-components/api-headers-document
Gathering detailed insights and metrics for @api-components/api-headers-document
⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.
Installations
npm install @api-components/api-headers-documentDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
14.21.3
NPM Version
6.14.18
Releases
6
Languages
1
JavaScript
JavaScript (100%)
Developer
advanced-rest-client
Download Statistics
Total Downloads
58,740
Last Day
1
Last Week
13
Last Month
91
Last Year
4,342
GitHub Statistics
100 Commits
2 Forks
3 Watchers
16 Branches
7 Contributors
Updated on Apr 22, 2024
Bundle Size
496.08 kB
Minified
117.56 kB
Minified + Gzipped
Maintainers
4
Package Meta Information
Latest Version
4.2.6
Package Id
@api-components/api-headers-document@4.2.6
Unpacked Size
16.55 kB
Size
4.69 kB
File Count
10
NPM Version
6.14.18
Node Version
14.21.3
Published on
Apr 22, 2024
Total Downloads
Cumulative downloads
Total Downloads
58,740
Last Day
0%
1
Compared to previous day
Last Week
-18.8%
13
Compared to previous week
Last Month
-60.1%
91
Compared to previous month
Last Year
-6.9%
4,342
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
5
Dev Dependencies
18
@advanced-rest-client/arc-demo-helper@api-components/amf-helper-mixin@api-components/api-model-generator@api-components/api-navigation@commitlint/cli@commitlint/config-conventional@open-wc/eslint-config@open-wc/testing@web/dev-server@web/test-runner@web/test-runner-playwrighteslinteslint-config-prettierhuskylint-stagedsinontypescripttypescript-lit-html-plugin
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 headers 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
1npm install --save @api-components/api-headers-document
In an html file
1<html> 2 <head> 3 <script type="module"> 4 import '@api-components/api-headers-document/api-headers-document.js'; 5 </script> 6 </head> 7 <body> 8 <api-headers-document></api-headers-document> 9 </body> 10</html>
1import { LitElement, html } from 'lit-element'; 2import '@api-components/api-headers-document/api-headers-document.js'; 3 4class SampleElement extends PolymerElement { 5 render() { 6 return html` 7 <api-headers-document .amf="${this.amf}"></api-headers-document> 8 `; 9 } 10} 11customElements.define('sample-element', SampleElement);
Development
1git clone https://github.com/api-components/api-headers-document 2cd api-headers-document 3npm install
Running the demo locally
1npm start
Running the tests
1npm test
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/deployment.yml:58
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 0 commits out of 17 are checked with a SAST tool
Reason
Found 6/20 approved changesets -- score normalized to 3
Reason
dependency not pinned by hash detected -- score normalized to 1
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:53: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:70: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/deployment.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/deployment.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/deployment.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/deployment.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/deployment.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/advanced-rest-client/api-headers-document/deployment.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/deployment.yml:81
- Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 third-party GitHubAction dependencies pinned
- Info: 1 out of 2 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/deployment.yml:1
- Info: no jobLevel write permissions found
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
license file not detected
Details
- Warn: project does not have a license file
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
41 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
- Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
- Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-7gc6-qh9x-w6h8
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-p3vf-v8qc-cwcr
- Warn: Project is vulnerable to: GHSA-gx9m-whjm-85jf
- Warn: Project is vulnerable to: GHSA-mmhx-hmjr-r674
- Warn: Project is vulnerable to: GHSA-vhxf-7vqr-mrjg
- Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-xvf7-4v9q-58w6
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-593f-38f6-jp5m
- Warn: Project is vulnerable to: GHSA-x2rg-q646-7m2v
- Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj
- Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
- Warn: Project is vulnerable to: GHSA-q674-xm3x-2926
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-3949-f494-cm99
- Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg
- Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Score
3.7
/10
Last Scanned on 2025-05-05
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More