npmpackage.info

@api-components/api-headers-document

⛔️ DEPRECATED This component is being deprecated. Use `api-documentation` instead.

4.2.6

JavaScript

16.55 kB

Installations

npm install @api-components/api-headers-document

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.21.3

NPM Version

6.14.18 Score

69.1

Supply Chain

Quality

80.8

Maintenance

Vulnerability

95.8

License

Pull Requests

Open

11

Total

39

Closed

19

Merged

9

Issues

Open

1

Total

1

Closed

0

Releases

v4.2.6

Published on 22 Apr 2024

v4.2.5

Published on 13 Jul 2022

v4.2.4

Published on 28 Sept 2021

v4.2.3

Published on 08 Sept 2021

v4.2.2

Published on 10 Aug 2021

v4.2.1

Published on 06 Apr 2021

View all 6 releases

Contributors

Unable to fetch Contributors

View all 7 contributors

Languages

JavaScript

JavaScript (100%)

Developer

advanced-rest-client

Download Statistics

Total Downloads

58,164

Last Day

Last Week

Last Month

127

Last Year

6,228

GitHub Statistics

100 Commits

2 Forks

4 Watching

16 Branches

7 Contributors

Maintainers

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

NPM Version

6.14.18

Node Version

14.21.3

Publised On

22 Apr 2024

Total Downloads

Cumulative downloads

Total Downloads

58,164

Last day

-66.7%

Compared to previous day

Last week

-18.2%

Compared to previous week

Last month

-29.1%

127

Compared to previous month

Last year

82.5%

6,228

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

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.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

7

SAST

Determines if the project uses static code analysis.

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

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: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: 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: 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

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

License

Determines if the project has defined a license.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.7

/10

Last Scanned on 2024-12-23

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

@api-components/api-headers-document

Installations

Developer Guide

No

CommonJS

14.21.3

6.14.18

Score

Pull Requests

11

39

19

9

Issues

1

1

0

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

advanced-rest-client

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

58,164

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

DEPRECATED

Version compatibility

Usage

Installation

In an html file

Development

Running the demo locally

Running the tests

10

10

10

7

3

1

0

0

0

0

0

0

0

3.7

/10