Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .changeset/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"changelog": [
"@fingerprintjs/changesets-changelog-format",
{
"repo": "fingerprintjs/fingerprint-pro-server-api-openapi"
"repo": "fingerprintjs/openapi"
}
]
}
5 changes: 5 additions & 0 deletions .changeset/openapi-repo-rename-license-url.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'openapi': patch
---

Update `license.url` for the Server API v3
2 changes: 1 addition & 1 deletion .github/workflows/schema-diff-pr-comment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ jobs:
- name: Compute known remote schema files
id: known-remote
env:
MANIFEST_URL: https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/index.json
MANIFEST_URL: https://fingerprintjs.github.io/openapi/schemas/index.json
run: |
KNOWN_REMOTE_FILES="$(curl -fsSL "$MANIFEST_URL" | jq -r '.files[]' | paste -sd, -)"
echo "files=${KNOWN_REMOTE_FILES}" >> "$GITHUB_OUTPUT"
Expand Down
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Example:

```markdown
---
'fingerprint-pro-server-api-openapi': minor
'openapi': minor
---

**events**: Add `proxy_ml_score` to `Event`
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# fingerprint-pro-server-api-openapi
# openapi

## 3.8.0

Expand Down
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can find the schemas definitions in the [schemas](/schemas) folder. You can

Use the included [Swagger UI](https://github.com/swagger-api/swagger-ui) demo app to dynamically render your changes into a documentation site a preview them there. Some mistakes and inconsistencies are much easier to spot in rendered documentation than by looking at the raw schema.

1. Clone this repository: `git clone https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi.git`
1. Clone this repository: `git clone https://github.com/fingerprintjs/openapi.git`
2. Install dependencies: `pnpm install`
3. Run `pnpm dev` to start the demo app

Expand All @@ -45,7 +45,7 @@ Optional:
- Save a JSON report: `pnpm schema:diff:published -- --json-out ./tmp/schema-diff-report.json`
- Save the rendered PR comment body: `pnpm schema:diff:published -- --comment-out ./tmp/schema-diff-comment.md`
- Compare against a custom published base URL:
`pnpm schema:diff:published -- --base-url https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas`
`pnpm schema:diff:published -- --base-url https://fingerprintjs.github.io/openapi/schemas`

### Schema Validation

Expand All @@ -62,7 +62,7 @@ To validate that schema matches the actual API implementation we use a [special

### Describing changes

[Releases](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/releases) from this repository are propagated to our server-side SDKs, that's why it's important to provide meaningful release notes if there are relevant changes.
[Releases](https://github.com/fingerprintjs/openapi/releases) from this repository are propagated to our server-side SDKs, that's why it's important to provide meaningful release notes if there are relevant changes.
We use [changesets](https://github.com/changesets/changesets) for that. If you want to describe your changes, run:

```sh
Expand All @@ -74,7 +74,7 @@ Example changeset looks like this:

```markdown
---
'fingerprint-pro-server-api-openapi': minor
'openapi': minor
---

**visitors**: Add the confidence field to the VPN Detection Smart Signal
Expand All @@ -84,7 +84,7 @@ Example changeset looks like this:

- `visitors` - scope of the changes. Scopes are defined in the [config/scopes.yaml](config/scopes.yaml) file. Certain scopes are ignored in certain SDKs if they are not supported, meaning that they will be ignored for them. You will be prompted to select scope in the CLI.
- `Add the confidence field to the VPN Detection Smart Signal` - meaningful description of the change.
- `fingerprint-pro-server-api-openapi` - name of the package
- `openapi` - name of the package
- `minor` - version of the change, can be: `patch`, `minor`, `major`

#### Choosing the version bump
Expand All @@ -101,8 +101,8 @@ Don't create a changeset for documentation-only changes (descriptions, examples)

On every push into `main` (merged PR):

- The built schema is published to [GitHub pages](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/).
- The built schema is published as a [raw yaml file](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api.yaml).
- The built schema is published to [GitHub pages](https://fingerprintjs.github.io/openapi/).
- The built schema is published as a [raw yaml file](https://fingerprintjs.github.io/openapi/schemas/fingerprint-server-api.yaml).
- After GitHub Pages deploy, the docs repo OpenAPI sync workflows run. They open a PR only if the published spec changed, which updates the [API Reference](https://docs.fingerprint.com/reference/server-api-v4).

See the [publish.yml](.github/workflows/publish.yml) workflow for more details.
Expand All @@ -111,7 +111,7 @@ See the [publish.yml](.github/workflows/publish.yml) workflow for more details.

GitHub releases are used to generate Server SDKs based on a specific version of the OpenAPI schema.

After merging to `main`, if there are relevant changes, you can manually trigger the [Release](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/actions/workflows/release.yml) workflow, which will consume created changeset files and create PR with bumped version and updated changelog.
After merging to `main`, if there are relevant changes, you can manually trigger the [Release](https://github.com/fingerprintjs/openapi/actions/workflows/release.yml) workflow, which will consume created changeset files and create PR with bumped version and updated changelog.

### Release note sync with SDKs

Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
</a>
</p>
<p align="center">
<a href="https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/actions/workflows/validate.yml"><img src="https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/actions/workflows/validate.yml/badge.svg" alt="CI badge" /></a>
<a href="https://github.com/fingerprintjs/openapi/actions/workflows/validate.yml"><img src="https://github.com/fingerprintjs/openapi/actions/workflows/validate.yml/badge.svg" alt="CI badge" /></a>
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/:license-mit-blue.svg?style=flat"/></a>
<a href="https://discord.gg/39EpE2neBg"><img src="https://img.shields.io/discord/852099967190433792?style=logo&label=Discord&logo=Discord&logoColor=white" alt="Discord server"></a>
</p>
Expand All @@ -21,8 +21,9 @@ This repository contains the [OpenAPI](https://spec.openapis.org/oas/) schema of

## Getting started

- The OpenAPI schema is published to the [Fingerprint API reference](https://docs.fingerprint.com/reference/server-api) and also as a [Swagger UI app on GitHub pages](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/).
- You can also [download the latest schema file here](https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas/fingerprint-server-api-v4-with-examples.yaml).
- The OpenAPI schema is published to the [Fingerprint API reference](https://docs.fingerprint.com/reference/server-api) and also as a [Swagger UI app on GitHub pages](https://fingerprintjs.github.io/openapi/).
- You can also download the latest schema as [Server API schema (YAML)](https://docs.fingerprint.com/reference/server-api.yaml) or [Server API schema (JSON)](https://docs.fingerprint.com/reference/server-api.json).
- If you need the examples too, use [Server API schema with examples](https://fingerprintjs.github.io/openapi/schemas/fingerprint-server-api-v4-with-examples.yaml).

> [!NOTE]
> Please note that some signals and attributes present in the schema are only available to Enterprise or Pro Plus customers on request, as indicated in the signal description.
Expand All @@ -33,7 +34,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.

## Support and feedback

To report problems, ask questions, or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/issues). If you need private support, you can email us at [oss-support@fingerprint.com](mailto:oss-support@fingerprint.com).
To report problems, ask questions, or provide feedback, please use [Issues](https://github.com/fingerprintjs/openapi/issues). If you need private support, you can email us at [oss-support@fingerprint.com](mailto:oss-support@fingerprint.com).

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "fingerprint-pro-server-api-openapi",
"name": "openapi",
"private": true,
"version": "3.8.0",
"main": "index.js",
Expand Down
2 changes: 1 addition & 1 deletion schemas/fingerprint-server-api-for-sdks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ info:
license:
name: MIT
url: >-
https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi/blob/main/LICENSE
https://github.com/fingerprintjs/openapi/blob/main/LICENSE
tags:
- name: Fingerprint
description: >-
Expand Down
2 changes: 1 addition & 1 deletion scripts/schemaDiffPublished.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { renderSchemaDiffComment } from '../utils/schemaDiff/renderComment.ts';
import { buildUnifiedPatch } from '../utils/schemaDiff/unifiedPatch.ts';
import type { OpenApiDocument } from '../utils/openapi.ts';

const DEFAULT_BASE_URL = 'https://fingerprintjs.github.io/fingerprint-pro-server-api-openapi/schemas';
const DEFAULT_BASE_URL = 'https://fingerprintjs.github.io/openapi/schemas';
const DEFAULT_LOCAL_DIR = 'dist/schemas';

interface CliOptions {
Expand Down
Loading