Skip to content

Commit fc04d68

Browse files
claude[bot]claude
andauthored
docs: promote Threat Intelligence npm features out of beta (#50)
Removes the "(Beta)" status designation from the Threat Intelligence API NPM features docs so the feature reads as a live, supported capability: - astro.config.mjs: sidebar label "NPM features (Beta)" -> "NPM features" and removed the "Beta" tip badge on the NPM features group. - beta.md: title -> "NPM features"; reworded beta/pre-GA status prose to neutral language and removed the "spec may change without a version bump while in beta" caveat. - overview.md: heading, link text and table label -> "NPM features"; reworded status prose; removed the beta spec-stability caveat. - threat-intel-beta.yaml: reworded info.description and related-page link, server display description "Beta" -> "NPM features", and info.version "beta" -> "1.0". Deliberately unchanged: the /beta/ page URL and slug, the api-reference/threat-intelligence-beta route, schema/collection filenames, and the live API endpoint path /database/api/beta/. Co-authored-by: Claude <noreply@anthropic.com>
1 parent f573485 commit fc04d68

4 files changed

Lines changed: 16 additions & 21 deletions

File tree

astro.config.mjs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ export default defineConfig({
106106
{
107107
base: 'api-reference/threat-intelligence-beta',
108108
schema: './public/schemas/threat-intel-beta.yaml',
109-
sidebar: { label: 'NPM features (Beta)', group: threatIntelBetaSidebarGroup, collapsed: true },
109+
sidebar: { label: 'NPM features', group: threatIntelBetaSidebarGroup, collapsed: true },
110110
},
111111
]),
112112
],
@@ -169,7 +169,6 @@ export default defineConfig({
169169
threatIntelExtendedSidebarGroup,
170170
{
171171
label: 'NPM features',
172-
badge: { text: 'Beta', variant: 'tip' },
173172
collapsed: true,
174173
items: [
175174
{ slug: 'api-solutions/threat-intelligence-api/beta' },

public/schemas/threat-intel-beta.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
openapi: 3.1.0
22
info:
33
title: Patchstack Threat Intelligence API — NPM features
4-
version: beta
4+
version: '1.0'
55
summary: npm + WordPress vulnerability intelligence with nested response shape and cursor pagination.
66
description: |
7-
The Beta endpoints live alongside the v2 API and add npm coverage, an optional
7+
The npm endpoints live alongside the v2 API and add npm coverage, an optional
88
full advisory body, a consistent nested response shape, and cursor pagination.
99
They are the recommended endpoints for new integrations; v2 remains available
1010
for backwards compatibility.
@@ -64,7 +64,7 @@ info:
6464
6565
## Related pages
6666
67-
- Narrative guide with code samples: [NPM features (Beta)](/api-solutions/threat-intelligence-api/beta/)
67+
- Narrative guide with code samples: [NPM features](/api-solutions/threat-intelligence-api/beta/)
6868
- OpenAPI spec (import into Postman / Insomnia / Bruno / Hoppscotch): <https://docs.patchstack.com/schemas/threat-intel-beta.yaml>
6969
- Postman collection (pre-imported): <https://docs.patchstack.com/schemas/threat-intel-beta.postman_collection.json>
7070
@@ -76,7 +76,7 @@ info:
7676

7777
servers:
7878
- url: https://vdp-api.patchstack.com/database/api/beta
79-
description: Beta
79+
description: NPM features
8080

8181
security:
8282
- PSKey: []

src/content/docs/API solutions/Threat Intelligence API/beta.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "NPM features (Beta)"
2+
title: "NPM features"
33
excerpt: "npm-ecosystem coverage and the supporting additions on top of the Threat Intelligence API — the /all endpoint, cursor pagination, ?include=details, and the nested response shape."
44
hidden: false
55
metadata:
@@ -12,7 +12,7 @@ sidebar:
1212
label: "Overview"
1313
---
1414

15-
_The Beta surface extends the Threat Intelligence API ahead of GA. It runs at a separate base URL, ships its own OpenAPI spec, and is available to **selected partners working directly with Patchstack**. The shared endpoints (`/latest`, `/product/{type}/{name}/{version}`, `/product/{type}/{name}/{version}/exists`, `/batch`) behave the same as the stable API but accept extra parameters and return a nested response shape. This page documents only what's new — for the full spec including npm-flavour examples, see the [auto-generated reference](/api-reference/threat-intelligence-beta/). [Contact us](https://patchstack.com/for-hosts/) if you'd like access._
15+
_The npm features extend the Threat Intelligence API with npm-ecosystem coverage. They run at a separate base URL, ship their own OpenAPI spec, and are available to **selected partners working directly with Patchstack**. The shared endpoints (`/latest`, `/product/{type}/{name}/{version}`, `/product/{type}/{name}/{version}/exists`, `/batch`) behave the same as the stable API but accept extra parameters and return a nested response shape. This page documents only what's new — for the full spec including npm-flavour examples, see the [auto-generated reference](/api-reference/threat-intelligence-beta/). [Contact us](https://patchstack.com/for-hosts/) if you'd like access._
1616

1717
## Base URL
1818

@@ -30,9 +30,7 @@ https://vdp-api.patchstack.com/database/api/beta/
3030
| `?include=details` | List endpoints — adds an `advisory_details` markdown field to each item (npm). |
3131
| Nested response shape | All list endpoints — `product`, `cvss`, `cwe`, `version_info` objects in place of the v2 flat shape. |
3232

33-
The full Beta schema (every endpoint, parameter, response example) lives in the [auto-generated reference](/api-reference/threat-intelligence-beta/).
34-
35-
> **Spec stability:** the Beta spec may change without a version bump while the API is in beta. Pin a commit of the YAML in production integrations, or wait for the GA release when versioned URLs ship.
33+
The full npm-features schema (every endpoint, parameter, response example) lives in the [auto-generated reference](/api-reference/threat-intelligence-beta/).
3634

3735
## Pagination
3836

@@ -58,15 +56,15 @@ npm package slugs that include a `/` (e.g. `@scope/pkg`) conflict with the route
5856

5957
## Errors
6058

61-
In addition to the [stable error codes](/api-solutions/threat-intelligence-api/extended/#errors), Beta returns:
59+
In addition to the [stable error codes](/api-solutions/threat-intelligence-api/extended/#errors), the npm endpoints return:
6260

6361
| Status | Meaning |
6462
|---|---|
6563
| `422 Unprocessable Entity` | Invalid parameter combination (e.g. `cursor` + `page`), invalid `platform`, or `per_page > 500`. |
6664

67-
## Migration notes (stable v2 → beta)
65+
## Migration notes (stable v2 → npm endpoints)
6866

69-
- Beta npm responses use **nested objects** (`product`, `cvss`, `cwe`, `capec`, `version_info`) whereas the v2 shape is flat. Update parsers accordingly.
67+
- npm responses use **nested objects** (`product`, `cvss`, `cwe`, `capec`, `version_info`) whereas the v2 shape is flat. Update parsers accordingly.
7068
- `ghsa_id` was renamed to `ghsa` at the top level.
7169
- `direct_url` was renamed to `url` (the npm-flavoured shape exposes a single URL only).
7270
- The `description` field was dropped for npm (the title already includes it).

src/content/docs/API solutions/Threat Intelligence API/overview.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Custom pricing, activated on request — [contact us](https://patchstack.com/for
1818

1919
- [Guide](/api-solutions/threat-intelligence-api/extended/) · [Reference](/api-reference/threat-intelligence-extended/) · [OpenAPI](/schemas/threat-intel-extended.yaml) · [Postman](/schemas/threat-intel-extended.postman_collection.json) · [API properties](/api-solutions/threat-intelligence-api/api-properties/)
2020

21-
## NPM features (Beta)
21+
## NPM features
2222

23-
For partners covering JavaScript components, a Beta surface adds **npm-ecosystem coverage** alongside WordPress, available to **selected partners working directly with Patchstack**. Beyond npm itself it ships the supporting additions that make npm coverage workable at scale: the new `GET /all` endpoint, cursor pagination, `?include=details` for full advisory bodies, and a nested response shape the stable API will eventually adopt. Everything else (`/latest`, `/product/{type}/{name}/{version}`, `/batch`) is the same surface as the stable API.
23+
For partners covering JavaScript components, the npm features add **npm-ecosystem coverage** alongside WordPress, available to **selected partners working directly with Patchstack**. Beyond npm itself they ship the supporting additions that make npm coverage workable at scale: the new `GET /all` endpoint, cursor pagination, `?include=details` for full advisory bodies, and a nested response shape the stable API will eventually adopt. Everything else (`/latest`, `/product/{type}/{name}/{version}`, `/batch`) is the same surface as the stable API.
2424

25-
See the [NPM features (Beta)](/api-solutions/threat-intelligence-api/beta/) page for the full delta — base URL, parameters, pagination, errors, and migration notes — and the [auto-generated reference](/api-reference/threat-intelligence-beta/) for the full schema. [Contact us](https://patchstack.com/for-hosts/) for access.
25+
See the [NPM features](/api-solutions/threat-intelligence-api/beta/) page for the full delta — base URL, parameters, pagination, errors, and migration notes — and the [auto-generated reference](/api-reference/threat-intelligence-beta/) for the full schema. [Contact us](https://patchstack.com/for-hosts/) for access.
2626

2727
---
2828

@@ -32,12 +32,12 @@ The legacy [Standard tier](/api-solutions/threat-intelligence-api/standard/) is
3232

3333
## Using the API with your tools
3434

35-
The API ships with an OpenAPI spec and a generated Postman collection. Beta has its own spec — pick whichever you're integrating against:
35+
The API ships with an OpenAPI spec and a generated Postman collection. The npm features have their own spec — pick whichever you're integrating against:
3636

3737
| | OpenAPI spec | Postman collection |
3838
|---|---|---|
3939
| Threat Intelligence API | [`threat-intel-extended.yaml`](/schemas/threat-intel-extended.yaml) | [`threat-intel-extended.postman_collection.json`](/schemas/threat-intel-extended.postman_collection.json) |
40-
| NPM features (Beta) | [`threat-intel-beta.yaml`](/schemas/threat-intel-beta.yaml) | [`threat-intel-beta.postman_collection.json`](/schemas/threat-intel-beta.postman_collection.json) |
40+
| NPM features | [`threat-intel-beta.yaml`](/schemas/threat-intel-beta.yaml) | [`threat-intel-beta.postman_collection.json`](/schemas/threat-intel-beta.postman_collection.json) |
4141
| Standard *(legacy)* | [`threat-intel-standard.yaml`](/schemas/threat-intel-standard.yaml) | [`threat-intel-standard.postman_collection.json`](/schemas/threat-intel-standard.postman_collection.json) |
4242

4343
### Postman, Insomnia, Bruno or Hoppscotch
@@ -78,5 +78,3 @@ npx @openapitools/openapi-generator-cli generate \
7878
```
7979

8080
Speakeasy and Fern also consume the same spec and produce more idiomatic SDKs if you need a polished client library.
81-
82-
> **Spec stability:** the Beta spec may change without a version bump while the API is in beta. Pin a commit of the YAML in production integrations, or wait for the GA release when we'll publish versioned URLs. The stable spec tracks the v2 surface.

0 commit comments

Comments
 (0)