From 4fe83ea31e6c7edf049673626634d68c82114360 Mon Sep 17 00:00:00 2001 From: Ewan Harris Date: Tue, 8 Oct 2024 13:58:42 +0100 Subject: [PATCH 1/2] chore: add changes from running sdk generator --- .openapi-generator/FILES | 11 ++++++++++- telemetry/attributes.ts | 13 +++++++++++++ telemetry/configuration.ts | 13 +++++++++++++ telemetry/counters.ts | 13 +++++++++++++ telemetry/histograms.ts | 13 +++++++++++++ telemetry/metrics.ts | 13 +++++++++++++ tests/telemetry/attributes.test.ts | 13 +++++++++++++ tests/telemetry/configuration.test.ts | 13 +++++++++++++ tests/telemetry/counters.test.ts | 13 +++++++++++++ tests/telemetry/histograms.test.ts | 13 +++++++++++++ tests/telemetry/metrics.test.ts | 13 +++++++++++++ 11 files changed, 140 insertions(+), 1 deletion(-) diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index fc0c244..e086dd2 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -43,13 +43,22 @@ example/opentelemetry/package.json git_push.sh index.ts package.json -telemetry.ts +telemetry/attributes.ts +telemetry/configuration.ts +telemetry/counters.ts +telemetry/histograms.ts +telemetry/metrics.ts tests/client.test.ts tests/helpers/default-config.ts tests/helpers/index.ts tests/helpers/nocks.ts tests/index.test.ts tests/jest.config.js +tests/telemetry/attributes.test.ts +tests/telemetry/configuration.test.ts +tests/telemetry/counters.test.ts +tests/telemetry/histograms.test.ts +tests/telemetry/metrics.test.ts tests/tsconfig.spec.json tests/validation.test.ts tsconfig.json diff --git a/telemetry/attributes.ts b/telemetry/attributes.ts index dcc2129..93b9c89 100644 --- a/telemetry/attributes.ts +++ b/telemetry/attributes.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { URL } from "url"; export enum TelemetryAttribute { diff --git a/telemetry/configuration.ts b/telemetry/configuration.ts index 25e046d..0df3948 100644 --- a/telemetry/configuration.ts +++ b/telemetry/configuration.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { FgaValidationError } from "../errors"; import { TelemetryAttribute } from "./attributes"; import { TelemetryMetric, MetricRecorder } from "./metrics"; diff --git a/telemetry/counters.ts b/telemetry/counters.ts index a8f21f8..b769077 100644 --- a/telemetry/counters.ts +++ b/telemetry/counters.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + export interface TelemetryCounter { name: string; unit: string; diff --git a/telemetry/histograms.ts b/telemetry/histograms.ts index 3906a48..6c014c6 100644 --- a/telemetry/histograms.ts +++ b/telemetry/histograms.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + export interface TelemetryHistogram { name: string; unit: string; diff --git a/telemetry/metrics.ts b/telemetry/metrics.ts index 4bf781b..a59f4b5 100644 --- a/telemetry/metrics.ts +++ b/telemetry/metrics.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { Counter, Histogram, Meter } from "@opentelemetry/api"; import { TelemetryCounter } from "./counters"; import { TelemetryHistogram } from "./histograms"; diff --git a/tests/telemetry/attributes.test.ts b/tests/telemetry/attributes.test.ts index aa3559c..e1551bc 100644 --- a/tests/telemetry/attributes.test.ts +++ b/tests/telemetry/attributes.test.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { TelemetryAttribute, TelemetryAttributes } from "../../telemetry/attributes"; describe("TelemetryAttributes", () => { diff --git a/tests/telemetry/configuration.test.ts b/tests/telemetry/configuration.test.ts index ade0081..1b0f781 100644 --- a/tests/telemetry/configuration.test.ts +++ b/tests/telemetry/configuration.test.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { TelemetryConfiguration, TelemetryMetricConfig } from "../../telemetry/configuration"; import { TelemetryAttribute } from "../../telemetry/attributes"; import { TelemetryMetric } from "../../telemetry/metrics"; diff --git a/tests/telemetry/counters.test.ts b/tests/telemetry/counters.test.ts index 64ddb57..5fb4453 100644 --- a/tests/telemetry/counters.test.ts +++ b/tests/telemetry/counters.test.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { TelemetryCounters } from "../../telemetry/counters"; describe("TelemetryCounters", () => { diff --git a/tests/telemetry/histograms.test.ts b/tests/telemetry/histograms.test.ts index a62a9a2..265ef38 100644 --- a/tests/telemetry/histograms.test.ts +++ b/tests/telemetry/histograms.test.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { TelemetryHistograms } from "../../telemetry/histograms"; describe("TelemetryHistograms", () => { diff --git a/tests/telemetry/metrics.test.ts b/tests/telemetry/metrics.test.ts index 7414194..823c6ff 100644 --- a/tests/telemetry/metrics.test.ts +++ b/tests/telemetry/metrics.test.ts @@ -1,3 +1,16 @@ +/** + * JavaScript and Node.js SDK for OpenFGA + * + * API version: 1.x + * Website: https://openfga.dev + * Documentation: https://openfga.dev/docs + * Support: https://openfga.dev/community + * License: [Apache-2.0](https://github.com/openfga/js-sdk/blob/main/LICENSE) + * + * NOTE: This file was auto generated by OpenAPI Generator (https://openapi-generator.tech). DO NOT EDIT. + */ + + import { MetricRecorder } from "../../telemetry/metrics"; import { TelemetryCounters } from "../../telemetry/counters"; import { TelemetryHistograms } from "../../telemetry/histograms"; From b0e4f79aefca4209e96fbed00afb779a99c7fe22 Mon Sep 17 00:00:00 2001 From: vil02 <65706193+vil02@users.noreply.github.com> Date: Tue, 8 Oct 2024 14:02:56 +0100 Subject: [PATCH 2/2] fix: update link to `SECURITY.md` --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59eeab2..82cac46 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,4 +43,4 @@ Please do not open issues for general support or usage questions. Instead, join ### Vulnerability Reporting -Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://github.com/openfga/js-sdk/blob/main/.github/SECURITY.md) details the procedure for disclosing security issues. +Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://github.com/openfga/.github/blob/main/SECURITY.md) details the procedure for disclosing security issues.