diff --git a/.changeset/config.json b/.changeset/config.json index 14b404e3..594ff87b 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -14,7 +14,7 @@ "changelog": [ "@fingerprintjs/changesets-changelog-format", { - "repo": "fingerprintjs/fingerprint-pro-server-api-openapi" + "repo": "fingerprintjs/openapi" } ] } diff --git a/.changeset/openapi-repo-rename-license-url.md b/.changeset/openapi-repo-rename-license-url.md new file mode 100644 index 00000000..35aaf726 --- /dev/null +++ b/.changeset/openapi-repo-rename-license-url.md @@ -0,0 +1,5 @@ +--- +'openapi': patch +--- + +Update `license.url` for the Server API v3 diff --git a/.github/workflows/schema-diff-pr-comment.yml b/.github/workflows/schema-diff-pr-comment.yml index 9b1219b3..ea02b936 100644 --- a/.github/workflows/schema-diff-pr-comment.yml +++ b/.github/workflows/schema-diff-pr-comment.yml @@ -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" diff --git a/AGENTS.md b/AGENTS.md index 1e8d9582..172b6069 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -34,7 +34,7 @@ Example: ```markdown --- -'fingerprint-pro-server-api-openapi': minor +'openapi': minor --- **events**: Add `proxy_ml_score` to `Event` diff --git a/CHANGELOG.md b/CHANGELOG.md index 3a53241c..252b385f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# fingerprint-pro-server-api-openapi +# openapi ## 3.8.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 798618ff..216e515f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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. @@ -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 diff --git a/README.md b/README.md index e6bd35cf..106998ac 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@

- CI badge + CI badge Discord server

@@ -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. @@ -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 diff --git a/package.json b/package.json index 7e97f84c..ba03cd3d 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "fingerprint-pro-server-api-openapi", + "name": "openapi", "private": true, "version": "3.8.0", "main": "index.js", diff --git a/schemas/fingerprint-server-api-for-sdks.yaml b/schemas/fingerprint-server-api-for-sdks.yaml index 7dc7c161..34358bdd 100644 --- a/schemas/fingerprint-server-api-for-sdks.yaml +++ b/schemas/fingerprint-server-api-for-sdks.yaml @@ -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: >- diff --git a/scripts/schemaDiffPublished.ts b/scripts/schemaDiffPublished.ts index 687051e9..86281888 100644 --- a/scripts/schemaDiffPublished.ts +++ b/scripts/schemaDiffPublished.ts @@ -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 {