{"id":21451184,"url":"https://github.com/lenra-io/internal-api-client-lib-java","last_synced_at":"2025-07-11T07:40:46.734Z","repository":{"id":213373858,"uuid":"733859511","full_name":"lenra-io/internal-api-client-lib-java","owner":"lenra-io","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-03T14:04:54.000Z","size":605,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-03T15:23:24.326Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lenra-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["lenra-io"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-12-20T09:44:02.000Z","updated_at":"2025-02-03T14:04:56.000Z","dependencies_parsed_at":"2023-12-20T17:27:28.234Z","dependency_job_id":"fe90bd19-4e5e-444d-b3c2-03544288c0a9","html_url":"https://github.com/lenra-io/internal-api-client-lib-java","commit_stats":null,"previous_names":["lenra-io/internal-api-client-lib-java"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lenra-io%2Finternal-api-client-lib-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lenra-io","download_url":"https://codeload.github.com/lenra-io/internal-api-client-lib-java/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243963814,"owners_count":20375678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T04:18:39.172Z","updated_at":"2025-03-17T02:41:20.186Z","avatar_url":"https://github.com/lenra-io.png","language":"Java","funding_links":["https://github.com/sponsors/lenra-io"],"categories":[],"sub_categories":[],"readme":"# lenra-internal-api-client\n\nLenra server internal API\n- API version: 0.0.0\n  - Build date: 2023-12-20T13:30:58.062007Z[Etc/UTC]\n\nThe API usable by the Lenra applications\n\nFor more information, please visit [https://www.lenra.io/contact.html](https://www.lenra.io/contact.html)\n\n*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*\n\n\n## Requirements\n\nBuilding the API client library requires:\n1. Java 1.8+\n2. Maven (3.8.3+)/Gradle (7.2+)\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn clean install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn clean deploy\n```\n\nRefer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003eio.lenra\u003c/groupId\u003e\n  \u003cartifactId\u003elenra-internal-api-client\u003c/artifactId\u003e\n  \u003cversion\u003e0.0.0\u003c/version\u003e\n  \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\n  repositories {\n    mavenCentral()     // Needed if the 'lenra-internal-api-client' jar has been published to maven central.\n    mavenLocal()       // Needed if the 'lenra-internal-api-client' jar has been published to the local maven repo.\n  }\n\n  dependencies {\n     implementation \"io.lenra:lenra-internal-api-client:0.0.0\"\n  }\n```\n\n### Others\n\nAt first generate the JAR by executing:\n\n```shell\nmvn clean package\n```\n\nThen manually install the following JARs:\n\n* `target/lenra-internal-api-client-0.0.0.jar`\n* `target/lib/*.jar`\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following Java code:\n\n```java\n\n// Import classes:\nimport io.lenra.api.internal.ApiClient;\nimport io.lenra.api.internal.ApiException;\nimport io.lenra.api.internal.Configuration;\nimport io.lenra.api.internal.auth.*;\nimport io.lenra.api.internal.models.*;\nimport io.lenra.api.internal.client.DataApi;\n\npublic class Example {\n  public static void main(String[] args) {\n    ApiClient defaultClient = Configuration.getDefaultApiClient();\n    defaultClient.setBasePath(\"http://localhost:4001\");\n    \n    // Configure HTTP bearer authorization: bearerAuth\n    HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication(\"bearerAuth\");\n    bearerAuth.setBearerToken(\"BEARER TOKEN\");\n\n    DataApi apiInstance = new DataApi(defaultClient);\n    try {\n      apiInstance.abortTransaction();\n    } catch (ApiException e) {\n      System.err.println(\"Exception when calling DataApi#abortTransaction\");\n      System.err.println(\"Status code: \" + e.getCode());\n      System.err.println(\"Reason: \" + e.getResponseBody());\n      System.err.println(\"Response headers: \" + e.getResponseHeaders());\n      e.printStackTrace();\n    }\n  }\n}\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:4001*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DataApi* | [**abortTransaction**](docs/DataApi.md#abortTransaction) | **POST** /app-api/v1/data/transaction/abort | Aborts a transaction\n*DataApi* | [**commitTransaction**](docs/DataApi.md#commitTransaction) | **POST** /app-api/v1/data/transaction/commit | Commits a transaction\n*DataApi* | [**createDocument**](docs/DataApi.md#createDocument) | **POST** /app-api/v1/data/colls/{coll}/docs | Creates a document in database\n*DataApi* | [**createTransaction**](docs/DataApi.md#createTransaction) | **POST** /app-api/v1/data/transaction | Creates a transaction\n*DataApi* | [**deleteCollection**](docs/DataApi.md#deleteCollection) | **DELETE** /app-api/v1-api/v1/data/colls/{coll} | Deletes a collection from database\n*DataApi* | [**deleteDocumentById**](docs/DataApi.md#deleteDocumentById) | **DELETE** /app-api/v1/data/colls/{coll}/docs/{id} | Deletes a document from database\n*DataApi* | [**findDocuments**](docs/DataApi.md#findDocuments) | **POST** /app-api/v1/data/colls/{coll}/find | Finds documents in database\n*DataApi* | [**getDocumentById**](docs/DataApi.md#getDocumentById) | **GET** /app-api/v1/data/colls/{coll}/docs/{id} | Gets a document from database\n*DataApi* | [**getDocuments**](docs/DataApi.md#getDocuments) | **GET** /app-api/v1/data/colls/{coll}/docs | Gets documents from database\n*DataApi* | [**updateDocumentById**](docs/DataApi.md#updateDocumentById) | **PUT** /app-api/v1/data/colls/{coll}/docs/{id} | Updates a document in database\n*DataApi* | [**updateManyDocuments**](docs/DataApi.md#updateManyDocuments) | **POST** /app-api/v1/data/colls/{coll}/updateMany | Updates many documents in database\n\n\n## Documentation for Models\n\n - [DataDocument](docs/DataDocument.md)\n - [FindDocumentsRequest](docs/FindDocumentsRequest.md)\n - [UpdateManyDocumentsRequest](docs/UpdateManyDocumentsRequest.md)\n\n\n\u003ca id=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation for Authorization\n\n\nAuthentication schemes defined for the API:\n\u003ca id=\"bearerAuth\"\u003e\u003c/a\u003e\n### bearerAuth\n\n- **Type**: HTTP Bearer Token authentication\n\n\n## Recommendation\n\nIt's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please open an issue with the tag \"enhancement\".\nDon't forget to give the project a star if you liked it! Thanks again!generate\n\n### Generate classes\n\nA part of this lib is generated from the [Lenra API](https://github.com/lenra-io/api).\nTo generate the classes, run the following commands:\n\n```bash\n# Load API\n## With wget\nwget https://github.com/lenra-io/api/releases/latest/download/load-api.sh -O - -q | bash\n## With curl\ncurl -fsSL https://github.com/lenra-io/api/releases/latest/download/load-api.sh | bash\n```\n\nGenerate\n\n```bash\ndocker run --rm -v ${PWD}:/local --workdir /local openapitools/openapi-generator-cli batch /local/gen-conf/java.yml\n```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the **MIT** License. See [LICENSE](./LICENSE) for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flenra-io%2Finternal-api-client-lib-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flenra-io%2Finternal-api-client-lib-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flenra-io%2Finternal-api-client-lib-java/lists"}