Skip to content

Commit

Permalink
ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.361.1
Browse files Browse the repository at this point in the history
  • Loading branch information
speakeasybot authored and srenatus committed Aug 12, 2024
1 parent 424fbad commit ac32500
Show file tree
Hide file tree
Showing 72 changed files with 2,116 additions and 1,027 deletions.
6 changes: 3 additions & 3 deletions .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: false
typescript:
version: 1.3.0
version: 1.4.0
additionalDependencies:
dependencies: {}
devDependencies:
"@types/node": ^20.14.9
'@types/node': ^20.14.9
eslint-plugin-markdown: ^4.0.1
prettier: 3.2.5
testcontainers: ^10.10.1
Expand Down Expand Up @@ -54,7 +54,7 @@ typescript:
methodArguments: require-security-and-request
moduleFormat: dual
outputModelSuffix: output
packageName: "@styra/opa"
packageName: '@styra/opa'
responseFormat: envelope-http
templateVersion: v2
useIndexModules: true
12 changes: 6 additions & 6 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
speakeasyVersion: 1.334.0
speakeasyVersion: 1.361.1
sources:
openapi:
sourceNamespace: openapi
sourceRevisionDigest: sha256:93669fe964484357296c2154d1c86aef99d8ca473969ee8d70e6710ed0d80ddb
sourceBlobDigest: sha256:bff74eb96d1677dce36fd84c18da761c1a7739ec423eb3eb1bab869e5bf48321
sourceRevisionDigest: sha256:041a9c6f5a9a2ad11fb0ecb4c958ee21331d4c1df411241715405a481a0842f4
sourceBlobDigest: sha256:1278b402479d50883b21bc284419cdd247db61f17087a97dd47531b54f0c326c
tags:
- latest
- main
- dependabot-npm_and_yarn-multi-875484771a
targets:
first-target:
source: openapi
sourceNamespace: openapi
sourceRevisionDigest: sha256:93669fe964484357296c2154d1c86aef99d8ca473969ee8d70e6710ed0d80ddb
sourceBlobDigest: sha256:bff74eb96d1677dce36fd84c18da761c1a7739ec423eb3eb1bab869e5bf48321
sourceRevisionDigest: sha256:041a9c6f5a9a2ad11fb0ecb4c958ee21331d4c1df411241715405a481a0842f4
sourceBlobDigest: sha256:1278b402479d50883b21bc284419cdd247db61f17087a97dd47531b54f0c326c
outLocation: packages/opa
workflow:
workflowVersion: 1.0.0
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions packages/opa/.gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
/funcs
/core.*
/esm
/dist
/.tshy
Expand Down
34 changes: 26 additions & 8 deletions packages/opa/.speakeasy/gen.lock
Original file line number Diff line number Diff line change
@@ -1,51 +1,66 @@
lockVersion: 2.0.0
id: 078615ff-ff96-44f8-8aca-2f4d3e687bf0
management:
docChecksum: 965922378d3f89a95cf055454ae72ad7
docChecksum: 553ed43ff98c81b3e770c34850f0b5f5
docVersion: 0.2.0
speakeasyVersion: 1.334.0
generationVersion: 2.369.0
releaseVersion: 1.3.0
configChecksum: 25eea4d12bca4a64556ebe5572cdafb3
speakeasyVersion: 1.361.1
generationVersion: 2.393.4
releaseVersion: 1.4.0
configChecksum: 931fe09dabde06c0b0a9d81cf9c8e1da
repoURL: https://github.com/StyraInc/opa-typescript.git
repoSubDirectory: packages/opa
installationURL: https://gitpkg.now.sh/StyraInc/opa-typescript/packages/opa
features:
typescript:
additionalDependencies: 0.1.0
constsAndDefaults: 0.1.5
core: 3.11.6
constsAndDefaults: 0.1.7
core: 3.13.1
defaultEnabledRetries: 0.1.0
envVarSecurityUsage: 0.1.1
examples: 2.81.4
flattening: 2.81.1
globalSecurity: 2.82.11
globalSecurityCallbacks: 0.1.0
globalSecurityFlattening: 0.1.0
globalServerURLs: 2.82.4
responseFormat: 0.2.3
retries: 2.83.0
sdkHooks: 0.1.0
unions: 2.85.5
unions: 2.85.7
generatedFiles:
- src/funcs/executeDefaultPolicyWithInput.ts
- src/funcs/executePolicy.ts
- src/funcs/executePolicyWithInput.ts
- src/funcs/executeBatchPolicyWithInput.ts
- src/funcs/health.ts
- src/sdk/sdk.ts
- .eslintrc.cjs
- RUNTIMES.md
- jsr.json
- package.json
- src/core.ts
- src/lib/base64.ts
- src/lib/config.ts
- src/lib/dlv.ts
- src/lib/encodings.ts
- src/lib/http.ts
- src/lib/is-plain-object.ts
- src/lib/logger.ts
- src/lib/matchers.ts
- src/lib/primitives.ts
- src/lib/retries.ts
- src/lib/schemas.ts
- src/lib/sdks.ts
- src/lib/security.ts
- src/lib/url.ts
- src/sdk/index.ts
- src/sdk/models/errors/httpclienterrors.ts
- src/sdk/models/errors/sdkerror.ts
- src/sdk/models/errors/sdkvalidationerror.ts
- src/types/blobs.ts
- src/types/constdatetime.ts
- src/types/enums.ts
- src/types/fp.ts
- src/types/index.ts
- src/types/operations.ts
- src/types/rfcdate.ts
Expand All @@ -66,6 +81,7 @@ generatedFiles:
- src/sdk/models/components/batchmixedresults.ts
- src/sdk/models/components/batchsuccessfulpolicyevaluation.ts
- src/sdk/models/components/healthyserver.ts
- src/sdk/models/components/security.ts
- src/sdk/models/errors/clienterror.ts
- src/sdk/models/errors/servererror.ts
- src/sdk/models/errors/batchservererror.ts
Expand Down Expand Up @@ -102,6 +118,7 @@ generatedFiles:
- docs/sdk/models/components/batchmixedresults.md
- docs/sdk/models/components/batchsuccessfulpolicyevaluation.md
- docs/sdk/models/components/healthyserver.md
- docs/sdk/models/components/security.md
- docs/sdk/models/errors/location.md
- docs/sdk/models/errors/errors.md
- docs/sdk/models/errors/clienterror.md
Expand All @@ -117,3 +134,4 @@ generatedFiles:
- src/hooks/hooks.ts
- src/hooks/types.ts
- src/hooks/index.ts
- CONTRIBUTING.md
26 changes: 26 additions & 0 deletions packages/opa/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing to This Repository

Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements.

## How to Report Issues

If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes:

- A clear and descriptive title
- Steps to reproduce the issue
- Expected and actual behavior
- Any relevant logs, screenshots, or error messages
- Information about your environment (e.g., operating system, software versions)
- For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed

## Issue Triage and Upstream Fixes

We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code.

## Contact

If you have any questions or need further assistance, please feel free to reach out by opening an issue.

Thank you for your understanding and cooperation!

The Maintainers
81 changes: 58 additions & 23 deletions packages/opa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,28 +301,22 @@ Some of the endpoints in this SDK support retries. If you use the SDK without a
To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
```typescript
import { OpaApiClient } from "@styra/opa";
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";

const opaApiClient = new OpaApiClient();

async function run() {
const result = await opaApiClient.executeDefaultPolicyWithInput(
8203.11,
false,
GzipAcceptEncoding.Gzip,
{
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
}
);
retryConnectionErrors: false,
},
});

// Handle the result
console.log(result);
Expand All @@ -335,7 +329,6 @@ run();
If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
```typescript
import { OpaApiClient } from "@styra/opa";
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";

const opaApiClient = new OpaApiClient({
retryConfig: {
Expand All @@ -351,11 +344,7 @@ const opaApiClient = new OpaApiClient({
});

async function run() {
const result = await opaApiClient.executeDefaultPolicyWithInput(
8203.11,
false,
GzipAcceptEncoding.Gzip
);
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);

// Handle the result
console.log(result);
Expand All @@ -366,6 +355,52 @@ run();
```
<!-- End Retries [retries] -->

<!-- Start Authentication [security] -->
## Authentication

### Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme |
| ------------ | ------------ | ------------ |
| `bearerAuth` | http | HTTP Bearer |

To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK client instance. For example:
```typescript
import { OpaApiClient } from "@styra/opa";

const opaApiClient = new OpaApiClient({
bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);

// Handle the result
console.log(result);
}

run();

```
<!-- End Authentication [security] -->

<!-- Start Debugging [debug] -->
## Debugging

To log HTTP requests and responses, you can pass a logger that matches `console`'s interface as an SDK option.

> [!WARNING]
> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
```typescript
import { OpaApiClient } from "@styra/opa";

const sdk = new OpaApiClient({ debugLogger: console });
```
<!-- End Debugging [debug] -->

<!-- Placeholder for Future Speakeasy SDK Sections -->

## Community
Expand Down
10 changes: 9 additions & 1 deletion packages/opa/RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,4 +397,12 @@ Based on:
- OpenAPI Doc
- Speakeasy CLI 1.334.0 (2.369.0) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v1.3.0] packages/opa
- [typescript v1.3.0] packages/opa

## 2024-08-12 08:27:31
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.361.1 (2.393.4) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v1.4.0] packages/opa
7 changes: 1 addition & 6 deletions packages/opa/USAGE.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
<!-- Start SDK Example Usage [usage] -->
```typescript
import { OpaApiClient } from "@styra/opa";
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";

const opaApiClient = new OpaApiClient();

async function run() {
const result = await opaApiClient.executeDefaultPolicyWithInput(
8203.11,
false,
GzipAcceptEncoding.Gzip
);
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);

// Handle the result
console.log(result);
Expand Down
8 changes: 8 additions & 0 deletions packages/opa/docs/sdk/models/components/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Security


## Fields

| Field | Type | Required | Description |
| ------------------ | ------------------ | ------------------ | ------------------ |
| `bearerAuth` | *string* | :heavy_minus_sign: | N/A |
7 changes: 2 additions & 5 deletions packages/opa/docs/sdks/opaapiclient/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,11 @@ Execute the default decision given an input

```typescript
import { OpaApiClient } from "@styra/opa";
import { GzipAcceptEncoding } from "@styra/opa/sdk/models/components";

const opaApiClient = new OpaApiClient();

async function run() {
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11, false, GzipAcceptEncoding.Gzip);
const result = await opaApiClient.executeDefaultPolicyWithInput(8203.11);

// Handle the result
console.log(result)
Expand Down Expand Up @@ -210,9 +209,7 @@ import { OpaApiClient } from "@styra/opa";
const opaApiClient = new OpaApiClient();

async function run() {
const result = await opaApiClient.health(false, false, [
"<value>",
]);
const result = await opaApiClient.health();

// Handle the result
console.log(result)
Expand Down
2 changes: 1 addition & 1 deletion packages/opa/jsr.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

{
"name": "@styra/opa",
"version": "1.3.0",
"version": "1.4.0",
"exports": {
".": "./src/index.ts",
"./sdk/models/errors": "./src/sdk/models/errors/index.ts",
Expand Down
8 changes: 4 additions & 4 deletions packages/opa/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@styra/opa",
"version": "1.3.0",
"version": "1.4.0",
"author": "Styra",
"license": "Apache-2.0",
"publishConfig": {
Expand Down Expand Up @@ -53,9 +53,9 @@
"testcontainers": "^10.10.1",
"tshy": "^1.16.2",
"tsx": "^4.16.2",
"typedoc": "^0.25.13",
"typedoc-plugin-extras": "^3.0.0",
"typedoc-plugin-replace-text": "^3.3.0",
"typedoc": "^0.26.5",
"typedoc-plugin-extras": "^3.1.0",
"typedoc-plugin-replace-text": "^4.0.0",
"typescript": "^5.4.5",
"zod": "^3.23.4"
},
Expand Down
Loading

0 comments on commit ac32500

Please sign in to comment.