Skip to content

Commit f99216d

Browse files
committed
chore: updated readme
1 parent c11db68 commit f99216d

File tree

8 files changed

+15
-479
lines changed

8 files changed

+15
-479
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,6 @@ _gradle.properties
2525
.openapi-generator
2626

2727

28-
*.bak
28+
*.bak
29+
.gradle/
30+
.openapi-generator/
-17 Bytes
Binary file not shown.
-1 Bytes
Binary file not shown.
-17 Bytes
Binary file not shown.

.gradle/8.7/gc.properties

Whitespace-only changes.

.openapi-generator/FILES

Lines changed: 0 additions & 431 deletions
This file was deleted.

.openapi-generator/VERSION

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 12 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,30 @@
1-
# openapi-java-client
1+
# Permify Java
22

33
Permify API
44

5-
- API version: v1.0.3
6-
7-
- Generator version: 7.14.0
5+
- Latest API version: 1.4.2
86

97
Permify is an open source authorization service for creating fine-grained and scalable authorization systems.
108

119
For more information, please visit [https://github.com/Permify/permify/issues](https://github.com/Permify/permify/issues)
1210

13-
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
14-
1511
## Requirements
1612

1713
Building the API client library requires:
1814

1915
1. Java 11+
2016
2. Maven/Gradle
2117

22-
## Installation
23-
24-
To install the API client library to your local Maven repository, simply execute:
25-
26-
```shell
27-
mvn clean install
28-
```
29-
30-
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
31-
32-
```shell
33-
mvn clean deploy
34-
```
35-
36-
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
37-
3818
### Maven users
3919

4020
Add this dependency to your project's POM:
4121

4222
```xml
23+
<!-- https://mvnrepository.com/artifact/co.permify/permify-java -->
4324
<dependency>
44-
<groupId>org.openapitools</groupId>
45-
<artifactId>openapi-java-client</artifactId>
46-
<version>v1.0.3</version>
47-
<scope>compile</scope>
25+
<groupId>co.permify</groupId>
26+
<artifactId>permify-java</artifactId>
27+
<version>${permify-java-version}</version>
4828
</dependency>
4929
```
5030

@@ -53,22 +33,10 @@ Add this dependency to your project's POM:
5333
Add this dependency to your project's build file:
5434

5535
```groovy
56-
compile "org.openapitools:openapi-java-client:v1.0.3"
57-
```
58-
59-
### Others
60-
61-
At first generate the JAR by executing:
62-
63-
```shell
64-
mvn clean package
36+
// https://mvnrepository.com/artifact/co.permify/permify-java
37+
implementation 'co.permify:permify-java:${permify-java-version}'
6538
```
6639

67-
Then manually install the following JARs:
68-
69-
- `target/openapi-java-client-v1.0.3.jar`
70-
- `target/lib/*.jar`
71-
7240
## Getting Started
7341

7442
Please follow the [installation](#installation) instruction and execute the following Java code:
@@ -129,8 +97,6 @@ Class | Method | HTTP request | Description
12997
*DataApi* | [**relationshipsDeleteWithHttpInfo**](docs/DataApi.md#relationshipsDeleteWithHttpInfo) | **POST** /v1/tenants/{tenant_id}/relationships/delete | delete relationships
13098
*DataApi* | [**relationshipsWrite**](docs/DataApi.md#relationshipsWrite) | **POST** /v1/tenants/{tenant_id}/relationships/write | write relationships
13199
*DataApi* | [**relationshipsWriteWithHttpInfo**](docs/DataApi.md#relationshipsWriteWithHttpInfo) | **POST** /v1/tenants/{tenant_id}/relationships/write | write relationships
132-
*HealthApi* | [**healthCheck**](docs/HealthApi.md#healthCheck) | **GET** /healthz | health api
133-
*HealthApi* | [**healthCheckWithHttpInfo**](docs/HealthApi.md#healthCheckWithHttpInfo) | **GET** /healthz | health api
134100
*PermissionApi* | [**permissionsCheck**](docs/PermissionApi.md#permissionsCheck) | **POST** /v1/tenants/{tenant_id}/permissions/check | check api
135101
*PermissionApi* | [**permissionsCheckWithHttpInfo**](docs/PermissionApi.md#permissionsCheckWithHttpInfo) | **POST** /v1/tenants/{tenant_id}/permissions/check | check api
136102
*PermissionApi* | [**permissionsExpand**](docs/PermissionApi.md#permissionsExpand) | **POST** /v1/tenants/{tenant_id}/permissions/expand | expand api
@@ -179,6 +145,7 @@ Class | Method | HTTP request | Description
179145
- [BundleRunResponse](docs/BundleRunResponse.md)
180146
- [BundleWriteBody](docs/BundleWriteBody.md)
181147
- [BundleWriteResponse](docs/BundleWriteResponse.md)
148+
- [CheckBody](docs/CheckBody.md)
182149
- [CheckResult](docs/CheckResult.md)
183150
- [CheckedExpr](docs/CheckedExpr.md)
184151
- [Child](docs/Child.md)
@@ -187,7 +154,6 @@ Class | Method | HTTP request | Description
187154
- [ComputedUserSet](docs/ComputedUserSet.md)
188155
- [Constant](docs/Constant.md)
189156
- [Context](docs/Context.md)
190-
- [ContextAttribute](docs/ContextAttribute.md)
191157
- [CreateList](docs/CreateList.md)
192158
- [CreateStruct](docs/CreateStruct.md)
193159
- [DataBundle](docs/DataBundle.md)
@@ -208,20 +174,18 @@ Class | Method | HTTP request | Description
208174
- [ExpandLeaf](docs/ExpandLeaf.md)
209175
- [ExpandTreeNode](docs/ExpandTreeNode.md)
210176
- [ExpandTreeNodeOperation](docs/ExpandTreeNodeOperation.md)
177+
- [Expr](docs/Expr.md)
211178
- [ExprCall](docs/ExprCall.md)
212179
- [FunctionType](docs/FunctionType.md)
213-
- [HealthResponse](docs/HealthResponse.md)
214180
- [Ident](docs/Ident.md)
215181
- [Leaf](docs/Leaf.md)
216182
- [ListType](docs/ListType.md)
217183
- [LookupEntityBody](docs/LookupEntityBody.md)
218184
- [LookupEntityStreamBody](docs/LookupEntityStreamBody.md)
219185
- [LookupSubjectBody](docs/LookupSubjectBody.md)
220186
- [MapType](docs/MapType.md)
221-
- [NullValue](docs/NullValue.md)
222187
- [PartialWriteBody](docs/PartialWriteBody.md)
223188
- [Partials](docs/Partials.md)
224-
- [PermissionCheckBody](docs/PermissionCheckBody.md)
225189
- [PermissionCheckRequestMetadata](docs/PermissionCheckRequestMetadata.md)
226190
- [PermissionCheckResponse](docs/PermissionCheckResponse.md)
227191
- [PermissionCheckResponseMetadata](docs/PermissionCheckResponseMetadata.md)
@@ -267,6 +231,7 @@ Class | Method | HTTP request | Description
267231
- [Status](docs/Status.md)
268232
- [StreamResultOfPermissionLookupEntityStreamResponse](docs/StreamResultOfPermissionLookupEntityStreamResponse.md)
269233
- [StreamResultOfWatchResponse](docs/StreamResultOfWatchResponse.md)
234+
- [StringArrayValue](docs/StringArrayValue.md)
270235
- [Subject](docs/Subject.md)
271236
- [SubjectFilter](docs/SubjectFilter.md)
272237
- [SubjectPermissionBody](docs/SubjectPermissionBody.md)
@@ -282,6 +247,7 @@ Class | Method | HTTP request | Description
282247
- [TupleSet](docs/TupleSet.md)
283248
- [TupleToUserSet](docs/TupleToUserSet.md)
284249
- [V1Call](docs/V1Call.md)
250+
- [V1Expand](docs/V1Expand.md)
285251
- [V1Operation](docs/V1Operation.md)
286252
- [V1alpha1Reference](docs/V1alpha1Reference.md)
287253
- [V1alpha1Type](docs/V1alpha1Type.md)

0 commit comments

Comments
 (0)