Skip to content

Commit 7e176b8

Browse files
authored
feat: add global parameters for app identification headers (#89)
2 parents b69646e + 8b5db1a commit 7e176b8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+98
-4023
lines changed

.speakeasy/gen.lock

Lines changed: 4 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
lockVersion: 2.0.0
22
id: 8b6cd71c-ea04-44da-af45-e43968b5928d
33
management:
4-
docChecksum: 459a4007b7391a38a6e9c7249c84c3bf
4+
docChecksum: bcccd1abd05f6654a822386f2eefbd8a
55
docVersion: 1.0.0
6-
speakeasyVersion: 1.658.2
6+
speakeasyVersion: 1.659.0
77
generationVersion: 2.755.9
88
releaseVersion: 0.1.17
9-
configChecksum: 1aa68a2fafd67f1deb74a05868fefaac
9+
configChecksum: 981848e5179cd35dc81cd362029ee736
1010
repoURL: https://github.com/OpenRouterTeam/typescript-sdk.git
1111
installationURL: https://github.com/OpenRouterTeam/typescript-sdk
1212
published: true
@@ -26,13 +26,13 @@ features:
2626
globalSecurityCallbacks: 0.1.0
2727
globalSecurityFlattening: 0.1.0
2828
globalServerURLs: 2.83.0
29+
globals: 2.82.2
2930
groups: 2.81.3
3031
methodArguments: 0.1.2
3132
methodSecurity: 2.82.6
3233
nameOverrides: 2.81.2
3334
nullables: 0.1.1
3435
openEnums: 0.1.1
35-
reactQueryHooks: 0.2.3
3636
responseFormat: 0.2.3
3737
retries: 2.83.0
3838
sdkHooks: 0.3.0
@@ -46,7 +46,6 @@ generatedFiles:
4646
- .devcontainer/setup.sh
4747
- .gitattributes
4848
- FUNCTIONS.md
49-
- REACT_QUERY.md
5049
- RUNTIMES.md
5150
- USAGE.md
5251
- docs/lib/utils/retryconfig.md
@@ -773,33 +772,6 @@ generatedFiles:
773772
- src/models/videourl.ts
774773
- src/models/websearchpreviewtooluserlocation.ts
775774
- src/models/websearchstatus.ts
776-
- src/react-query/_context.tsx
777-
- src/react-query/_types.ts
778-
- src/react-query/analyticsGetUserActivity.ts
779-
- src/react-query/apiKeysCreate.ts
780-
- src/react-query/apiKeysDelete.ts
781-
- src/react-query/apiKeysGet.ts
782-
- src/react-query/apiKeysGetCurrentKeyMetadata.ts
783-
- src/react-query/apiKeysList.ts
784-
- src/react-query/apiKeysUpdate.ts
785-
- src/react-query/betaResponsesSend.ts
786-
- src/react-query/chatSend.ts
787-
- src/react-query/completionsGenerate.ts
788-
- src/react-query/creditsCreateCoinbaseCharge.ts
789-
- src/react-query/creditsGetCredits.ts
790-
- src/react-query/embeddingsGenerate.ts
791-
- src/react-query/embeddingsListModels.ts
792-
- src/react-query/endpointsList.ts
793-
- src/react-query/endpointsListZdrEndpoints.ts
794-
- src/react-query/generationsGetGeneration.ts
795-
- src/react-query/index.ts
796-
- src/react-query/modelsCount.ts
797-
- src/react-query/modelsList.ts
798-
- src/react-query/modelsListForUser.ts
799-
- src/react-query/oAuthCreateAuthCode.ts
800-
- src/react-query/oAuthExchangeAuthCodeForAPIKey.ts
801-
- src/react-query/parametersGetParameters.ts
802-
- src/react-query/providersList.ts
803775
- src/sdk/analytics.ts
804776
- src/sdk/apikeys.ts
805777
- src/sdk/beta.ts

.speakeasy/gen.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ typescript:
6565
defaultErrorName: OpenRouterDefaultError
6666
enableCustomCodeRegions: true
6767
enableMCPServer: false
68-
enableReactQuery: true
68+
enableReactQuery: false
6969
enumFormat: union
7070
envVarPrefix: OPENROUTER
7171
exportZodModelNamespace: false

.speakeasy/out.openapi.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5650,7 +5650,7 @@ components:
56505650
- model
56515651
- choices
56525652
additionalProperties: false
5653-
parameters: {}
5653+
parameters: {AppIdentifier: {name: HTTP-Referer, in: header, schema: {type: string}, description: "The app identifier should be your app's URL and is used as the primary identifier for rankings.\nThis is used to track API usage per application.\n"}, AppDisplayName: {name: X-Title, in: header, schema: {type: string}, description: "The app display name allows you to customize how your app appears in OpenRouter's dashboard.\n"}}
56545654
securitySchemes:
56555655
apiKey:
56565656
type: http
@@ -8409,3 +8409,7 @@ x-retry-strategy:
84098409
initialDelay: 500
84108410
maxDelay: 60000
84118411
maxAttempts: 3
8412+
x-speakeasy-globals:
8413+
parameters:
8414+
- $ref: "#/components/parameters/AppIdentifier"
8415+
- $ref: "#/components/parameters/AppDisplayName"
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
overlay: 1.0.0
2+
x-speakeasy-jsonpath: rfc9535
3+
info:
4+
title: Add HTTP-Referer and X-Title as global parameters
5+
version: 0.0.0
6+
actions:
7+
# Add global parameters for app identification
8+
- target: $
9+
description: Add x-speakeasy-globals for HTTP-Referer and X-Title headers
10+
update:
11+
x-speakeasy-globals:
12+
parameters:
13+
- $ref: "#/components/parameters/AppIdentifier"
14+
- $ref: "#/components/parameters/AppDisplayName"
15+
16+
# Add component parameters
17+
- target: $.components
18+
description: Add parameters for app identification headers
19+
update:
20+
parameters:
21+
AppIdentifier:
22+
name: HTTP-Referer
23+
in: header
24+
schema:
25+
type: string
26+
description: |
27+
The app identifier should be your app's URL and is used as the primary identifier for rankings.
28+
This is used to track API usage per application.
29+
AppDisplayName:
30+
name: X-Title
31+
in: header
32+
schema:
33+
type: string
34+
description: |
35+
The app display name allows you to customize how your app appears in OpenRouter's dashboard.

.speakeasy/workflow.lock

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
1-
speakeasyVersion: 1.658.2
1+
speakeasyVersion: 1.659.0
22
sources:
33
OpenRouter API:
44
sourceNamespace: open-router-chat-completions-api
5-
sourceRevisionDigest: sha256:f1b59b9b643de5e20d6e3299a8274783d8c0854615876f5d7f6f081814842695
6-
sourceBlobDigest: sha256:ee1f2422281b3ed5b38951c74636ad192c9bb160f216069c1f7931ccc4e52553
5+
sourceRevisionDigest: sha256:ffe0e925561a55a1b403667fe33bb3158e05892ef1e66f56211544c9a890b301
6+
sourceBlobDigest: sha256:18aa7b22686c2f559af1062fea408a9f80146231027ed1fd62b68df38c71f65d
77
tags:
88
- latest
9-
- feat-update-sdk-models-and-spec
109
- 1.0.0
1110
targets:
1211
openrouter:
1312
source: OpenRouter API
1413
sourceNamespace: open-router-chat-completions-api
15-
sourceRevisionDigest: sha256:f1b59b9b643de5e20d6e3299a8274783d8c0854615876f5d7f6f081814842695
16-
sourceBlobDigest: sha256:ee1f2422281b3ed5b38951c74636ad192c9bb160f216069c1f7931ccc4e52553
14+
sourceRevisionDigest: sha256:ffe0e925561a55a1b403667fe33bb3158e05892ef1e66f56211544c9a890b301
15+
sourceBlobDigest: sha256:18aa7b22686c2f559af1062fea408a9f80146231027ed1fd62b68df38c71f65d
1716
codeSamplesNamespace: open-router-chat-completions-api-typescript-code-samples
18-
codeSamplesRevisionDigest: sha256:84b8958b8bfb3e2b25461ca49c1cf10e07bd3821337dec96333acd9a2829c701
17+
codeSamplesRevisionDigest: sha256:4206cfd1ad4a613178d55c5c1b1da20bcfd21bbaf1b63b8c80beec4bf16dd4b7
1918
workflow:
2019
workflowVersion: 1.0.0
2120
speakeasyVersion: latest
@@ -26,6 +25,7 @@ workflow:
2625
overlays:
2726
- location: .speakeasy/overlays/open-enums.overlay.yaml
2827
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
28+
- location: .speakeasy/overlays/add-headers.overlay.yaml
2929
output: .speakeasy/out.openapi.yaml
3030
registry:
3131
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api

.speakeasy/workflow.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ sources:
77
overlays:
88
- location: .speakeasy/overlays/open-enums.overlay.yaml
99
- location: .speakeasy/overlays/remove-rss-responses.overlay.yaml
10+
- location: .speakeasy/overlays/add-headers.overlay.yaml
1011
output: .speakeasy/out.openapi.yaml
1112
registry:
1213
location: registry.speakeasyapi.dev/openrouter/sdk/open-router-chat-completions-api

0 commit comments

Comments
 (0)