# Introduction These are the public APIs to enable implementing a custom client interface to the Glean system. # Usage guidelines This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along with a 6-month sunset period for anything that requires developers to adopt the new versions. # SDK Client bindings for the API can be generated for most popular languages (Python, Java, NodeJS, etc). To do so: Download the OpenAPI specification for the API, by clicking on one of the following options: 1. [Download JSON specification](https://api.redocly.com/registry/bundle/glean/Glean%20Client%20API%20SDK%20source/v1/openapi.json?branch=main&download=true) 2. [Download YAML specification](https://api.redocly.com/registry/bundle/glean/Glean%20Client%20API%20SDK%20source/v1/openapi.yaml?branch=main&download=true) Use [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator-cli) to generate bindings for your language of choice, for example: ```bash shell $ npx @openapitools/openapi-generator-cli@latest generate -i client_api.yaml -g go ``` To see available languages: ```bash shell $ npx @openapitools/openapi-generator-cli@latest list ``` Determine the host you need to connect to. This will be the URL of the backend for your Glean deployment, for example, customer-be.glean.com
Raw data
{
"_id": null,
"home_page": null,
"name": "glean-client-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Glean Client API",
"author": "OpenAPI Generator community",
"author_email": "support@glean.com",
"download_url": "https://files.pythonhosted.org/packages/80/b1/1a8ee4b7bee88c5f8be9e98874d9504f07809c488fa66d6af784e33a00fa/glean-client-api-1.0.0.tar.gz",
"platform": null,
"description": " # Introduction These are the public APIs to enable implementing a custom client interface to the Glean system. # Usage guidelines This API is evolving fast. Glean will provide advance notice of any planned backwards incompatible changes along with a 6-month sunset period for anything that requires developers to adopt the new versions. # SDK Client bindings for the API can be generated for most popular languages (Python, Java, NodeJS, etc). To do so: Download the OpenAPI specification for the API, by clicking on one of the following options: 1. [Download JSON specification](https://api.redocly.com/registry/bundle/glean/Glean%20Client%20API%20SDK%20source/v1/openapi.json?branch=main&download=true) 2. [Download YAML specification](https://api.redocly.com/registry/bundle/glean/Glean%20Client%20API%20SDK%20source/v1/openapi.yaml?branch=main&download=true) Use [openapi-generator-cli](https://github.com/OpenAPITools/openapi-generator-cli) to generate bindings for your language of choice, for example: ```bash shell $ npx @openapitools/openapi-generator-cli@latest generate -i client_api.yaml -g go ``` To see available languages: ```bash shell $ npx @openapitools/openapi-generator-cli@latest list ``` Determine the host you need to connect to. This will be the URL of the backend for your Glean deployment, for example, customer-be.glean.com \n \n",
"bugtrack_url": null,
"license": null,
"summary": "Glean Client API",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
"openapi",
" openapi-generator",
" glean client api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "935b2081699b8838da6385fe3adf6dd2a44502c0c2463c4fffc3b9cf777e7b80",
"md5": "aa39f22e3c0fe6abd4e505a54fc38ad7",
"sha256": "585499f4bc0f0ac4795c6d7b06b960e19415c25810adfd7df2edbbf66f9e7c63"
},
"downloads": -1,
"filename": "glean_client_api-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa39f22e3c0fe6abd4e505a54fc38ad7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 950528,
"upload_time": "2024-06-25T16:17:53",
"upload_time_iso_8601": "2024-06-25T16:17:53.873491Z",
"url": "https://files.pythonhosted.org/packages/93/5b/2081699b8838da6385fe3adf6dd2a44502c0c2463c4fffc3b9cf777e7b80/glean_client_api-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "80b11a8ee4b7bee88c5f8be9e98874d9504f07809c488fa66d6af784e33a00fa",
"md5": "4ca23ff94c54153e9a52c10a1bd23396",
"sha256": "501b7979cd8cbe3c7aac87589cb2e385bec9f10f7b902d5c680d1ed601dd5df8"
},
"downloads": -1,
"filename": "glean-client-api-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "4ca23ff94c54153e9a52c10a1bd23396",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 337084,
"upload_time": "2024-06-25T16:17:55",
"upload_time_iso_8601": "2024-06-25T16:17:55.457357Z",
"url": "https://files.pythonhosted.org/packages/80/b1/1a8ee4b7bee88c5f8be9e98874d9504f07809c488fa66d6af784e33a00fa/glean-client-api-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-25 16:17:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "glean-client-api"
}
JSON