diff --git a/.devcontainer/README.md b/.devcontainer/README.md index 25b9bfd0..3ad425b0 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,4 +1,9 @@ +
+ +
+
+ > **Remember to shutdown a GitHub Codespace when it is not in use!** # Dev Containers Quick Start diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index fcf20155..2c2fd080 100644 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,14 @@ lockVersion: 2.0.0 id: 3e3290ca-0ee8-4981-b1bc-14536048fa63 management: - docChecksum: adc860b8099788fe237e893e2a1ce2a4 + docChecksum: 6cb4c4786bf30fecfc20b38750d745eb docVersion: 0.9.0 - speakeasyVersion: 1.561.0 - generationVersion: 2.628.0 - releaseVersion: 0.6.5 - configChecksum: 6378ddf91bd99402a13555fcfc9817af + speakeasyVersion: 1.563.1 + generationVersion: 2.629.1 + releaseVersion: 0.6.6 + configChecksum: deb305dde9c116c694b15d39c5ae7854 + repoURL: https://github.com/gleanwork/api-client-python.git + installationURL: https://github.com/gleanwork/api-client-python.git published: true features: python: @@ -637,6 +639,7 @@ generatedFiles: - poetry.toml - py.typed - pylintrc + - scripts/prepare_readme.py - scripts/publish.sh - src/glean/api_client/__init__.py - src/glean/api_client/_hooks/__init__.py diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index 81856314..24d33d1b 100644 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -25,7 +25,7 @@ generation: generateNewTests: true skipResponseBodyAssertions: true python: - version: 0.6.5 + version: 0.6.6 additionalDependencies: dev: {} main: {} diff --git a/.speakeasy/glean-merged-spec.yaml b/.speakeasy/glean-merged-spec.yaml index 8a437821..04a2a3cc 100644 --- a/.speakeasy/glean-merged-spec.yaml +++ b/.speakeasy/glean-merged-spec.yaml @@ -351,7 +351,12 @@ paths: tags: - Authentication summary: Create authentication token - description: Creates an authentication token for the authenticated user. + description: | + Creates an authentication token for the authenticated user. These are + specifically intended to be used with the [Web SDK](https://developers.glean.com/web). + + Note: The tokens generated from this endpoint are **not** valid tokens + for use with the Client API (e.g. `/rest/api/v1/*`). operationId: createauthtoken x-visibility: Public parameters: [] diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index aab64b37..7763e349 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,11 +1,12 @@ -speakeasyVersion: 1.561.0 +speakeasyVersion: 1.563.1 sources: Glean API: sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:4d55e9d4c5116b88a5959816fd40df895912309a293908485e2016008d31a1f4 - sourceBlobDigest: sha256:eceb178c5d2537e6d21c0461c81f6af1dc245da2c327fdf5305a8191184eff94 + sourceRevisionDigest: sha256:766f374184dd7d6b119aef718a826e26e7e690a65bd8edd8e326c75699c9c0f5 + sourceBlobDigest: sha256:b566588e295fa760c08dc3e5f61f4026e3b295999709bbec5a3f434f51316f89 tags: - latest + - speakeasy-sdk-regen-1749670145 Glean Client API: sourceNamespace: glean-client-api sourceRevisionDigest: sha256:4edc63ad559e4f2c9fb9ebf5edaaaaa9269f1874d271cfd84b441d6dacac43d2 @@ -16,10 +17,10 @@ targets: glean: source: Glean API sourceNamespace: glean-api-specs - sourceRevisionDigest: sha256:4d55e9d4c5116b88a5959816fd40df895912309a293908485e2016008d31a1f4 - sourceBlobDigest: sha256:eceb178c5d2537e6d21c0461c81f6af1dc245da2c327fdf5305a8191184eff94 + sourceRevisionDigest: sha256:766f374184dd7d6b119aef718a826e26e7e690a65bd8edd8e326c75699c9c0f5 + sourceBlobDigest: sha256:b566588e295fa760c08dc3e5f61f4026e3b295999709bbec5a3f434f51316f89 codeSamplesNamespace: glean-api-specs-python-code-samples - codeSamplesRevisionDigest: sha256:04b4dd94d8ee358b8a408e1f8f46005a73c9bd86790e5abc631c5503ec22ff8f + codeSamplesRevisionDigest: sha256:6fc7a331ac2723e7e15b995ac16fcbcb8e5e23c00dba76053d4977ed1b7ea737 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/RELEASES.md b/RELEASES.md index 0db9f6b2..73bc2803 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -158,4 +158,14 @@ Based on: ### Generated - [python v0.6.5] . ### Releases -- [PyPI v0.6.5] https://pypi.org/project/glean/0.6.5 - . \ No newline at end of file +- [PyPI v0.6.5] https://pypi.org/project/glean/0.6.5 - . + +## 2025-06-16 01:46:36 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.563.1 (2.629.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [python v0.6.6] . +### Releases +- [PyPI v0.6.6] https://pypi.org/project/glean/0.6.6 - . \ No newline at end of file diff --git a/docs/sdks/clientauthentication/README.md b/docs/sdks/clientauthentication/README.md index ec1c1422..9fe09ba3 100644 --- a/docs/sdks/clientauthentication/README.md +++ b/docs/sdks/clientauthentication/README.md @@ -9,7 +9,12 @@ ## create_token -Creates an authentication token for the authenticated user. +Creates an authentication token for the authenticated user. These are +specifically intended to be used with the [Web SDK](https://developers.glean.com/web). + +Note: The tokens generated from this endpoint are **not** valid tokens +for use with the Client API (e.g. `/rest/api/v1/*`). + ### Example Usage diff --git a/pyproject.toml b/pyproject.toml index 0314dae4..9adb54e2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "glean-api-client" -version = "0.6.5" +version = "0.6.6" description = "Python Client SDK Generated by Speakeasy." authors = [{ name = "Glean Technologies, Inc." }] license = "MIT" diff --git a/scripts/publish.sh b/scripts/publish.sh index 1ee7194c..f2f2cf2c 100755 --- a/scripts/publish.sh +++ b/scripts/publish.sh @@ -2,4 +2,6 @@ export POETRY_PYPI_TOKEN_PYPI=${PYPI_TOKEN} +poetry run python scripts/prepare_readme.py + poetry publish --build --skip-existing diff --git a/src/glean/api_client/_version.py b/src/glean/api_client/_version.py index f29f093e..df7fe1fd 100644 --- a/src/glean/api_client/_version.py +++ b/src/glean/api_client/_version.py @@ -3,10 +3,10 @@ import importlib.metadata __title__: str = "glean" -__version__: str = "0.6.5" +__version__: str = "0.6.6" __openapi_doc_version__: str = "0.9.0" -__gen_version__: str = "2.628.0" -__user_agent__: str = "speakeasy-sdk/python 0.6.5 2.628.0 0.9.0 glean" +__gen_version__: str = "2.629.1" +__user_agent__: str = "speakeasy-sdk/python 0.6.6 2.629.1 0.9.0 glean" try: if __package__ is not None: diff --git a/src/glean/api_client/client_authentication.py b/src/glean/api_client/client_authentication.py index eb4557b8..42fd7b0a 100644 --- a/src/glean/api_client/client_authentication.py +++ b/src/glean/api_client/client_authentication.py @@ -19,7 +19,12 @@ def create_token( ) -> models.CreateAuthTokenResponse: r"""Create authentication token - Creates an authentication token for the authenticated user. + Creates an authentication token for the authenticated user. These are + specifically intended to be used with the [Web SDK](https://developers.glean.com/web). + + Note: The tokens generated from this endpoint are **not** valid tokens + for use with the Client API (e.g. `/rest/api/v1/*`). + :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method @@ -106,7 +111,12 @@ async def create_token_async( ) -> models.CreateAuthTokenResponse: r"""Create authentication token - Creates an authentication token for the authenticated user. + Creates an authentication token for the authenticated user. These are + specifically intended to be used with the [Web SDK](https://developers.glean.com/web). + + Note: The tokens generated from this endpoint are **not** valid tokens + for use with the Client API (e.g. `/rest/api/v1/*`). + :param retries: Override the default retry configuration for this method :param server_url: Override the default server URL for this method