https://github.com/ory/sdk
The place where ORY's SDKs are being auto-generated
https://github.com/ory/sdk
Last synced: 24 days ago
JSON representation
The place where ORY's SDKs are being auto-generated
- Host: GitHub
- URL: https://github.com/ory/sdk
- Owner: ory
- License: apache-2.0
- Created: 2019-12-30T14:21:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-29T14:44:10.000Z (about 1 month ago)
- Last Synced: 2025-05-07T15:02:57.133Z (about 1 month ago)
- Language: PHP
- Homepage:
- Size: 193 MB
- Stars: 155
- Watchers: 10
- Forks: 91
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Generated SDKs for the Ory Ecosystem
All SDKs provided in this repository are generated using openapi-generator.
## Ory Network SDKs
When developing against [Ory Network](https://www.ory.sh/docs/sdk), use the
latest `client` or `ory-client` SDK for your preferred language. It bundles the
individual SDKs (Identities, OAuth2, Permissions) and works with
[Ory API keys](https://www.ory.sh/docs/concepts/personal-access-token).
## Ory self-hosted SDKs
When developing against self-hosted Ory components (Kratos, Hydra, Keto), use
the corresponding individual SDKs for your language and match the SDK version to
the version of Kratos/Hydra/Keto you have deployed.
## Publish the Docker Image
To publish the SDK Builder Docker Image, create a new GitHub release with the
desired version.
You may also manually build and publish this image using:
```shell script
docker build --platform linux/adm64 -t oryd/sdk:latest .
docker tag oryd/sdk:latest oryd/sdk:v0.0.53
docker push oryd/sdk:v0.0.53
```
## Running the Image Locally
If you wish to debug some generators or build steps, you can run the image
locally:
```shell script
docker build -t oryd/sdk:latest .
docker run --mount type=bind,source="$(pwd)",target=/project --name sdk --user "$(id -u):$(id -g)" -it oryd/sdk:latest /bin/sh
```
### Debugging Failing Tests on CI
If a test fails in CI, you may run the following code snippet to reproduce the
failure locally:
```shell script
docker build -t oryd/sdk:latest .
docker run --rm --mount type=bind,source="$(pwd)",target=/project --name sdk -it oryd/sdk:latest /bin/bash
export FORCE_PROJECT=client # or hydra or something else
export FORCE_VERSION=$(cat /project/spec/$FORCE_PROJECT/latest) # or a specific version, e.g. v1.2.17
cd /project
./scripts/generate.sh
./scripts/test.sh
```
## Commit a new spec
Place the spec in `spec//.json` (e.g.
`spec/hydra/v0.0.0-alpha.1.json`) and create a commit that references both the
project and the version `git commit -a -m "Add spec for :"`
(e.g. `git commit -a -m "Add spec for hydra:v0.0.0-alpha.1"`).
**Do not create multiple commits adding several specs in one PR,** as only the
latest commit will be checked when it lands on master.
Because this is an automated process, it is highly recommended to add, commit,
and push the spec file directly to master in one go!
You can create a PR if you're making changes to the build chain.
## Upgrading OpenAPI Generator
Upgrading OpenAPI Generator versions requires careful upgrading of the Java
pom.xml. The file might contain new versions for dependencies, but if
overwritten, will not work with the release pipeline.
Therefore, the pom.xml file is being always overwritten from the contrib/poms
directory for each project. To update any dependencies, the changes must thus be
made there. We recommend running the openapi generator manually on the local
machine and diffing the changes with contents in contrib/poms.
## Publishing
## PHP - Packagist
Install PHP and [composer](https://packagist.org). Then, run the install command
to initialize everything:
```shell script
export PROJECT=hydra
cd clients/${PROJECT}/php
composer install
```
Then, push the directory to a git remote of your choosing and also publish the
tag you want to release the package as. You can take a look at
[./scripts/publish.sh](./scripts/publish.sh) to understand how to accomplish
that.
## Python - PyPi / pip
First, install all the necessary tools and python3:
```shell script
python3 -m pip install --user --upgrade setuptools wheel twine
```
Next, create a PyPi account and [API Token](https://pypi.org/manage/account/)
and set the env vars to:
```shell script
export TWINE_USERNAME=__token__
export TWINE_PASSWORD=
```
Then, publish the project (and set the project name):
```shell script
export PROJECT=hydra
cd clients/${PROJECT}/python
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*
```
## Ruby
You need to set `GEM_HOST_API_KEY`
## Java - Maven Central
For keys read https://blackdoor.github.io/blog/maven-cd/
Due to a
[bug in openapi-generator](https://github.com/OpenAPITools/openapi-generator/issues/3272)
that appears in Java11+, please disable javadoc generation:
```shell
mvn -Dmaven.javadoc.skip=true
```
To test the build for Java, run:
```
$ ./scripts/generate.sh
$ cd clients//java
$ mvn test-compile
```
You will also need a PGP keypair that is associated with one of the owners of
the `sh.ory` group and that is published on one of the public key servers. For
more details, see:
[https://dzone.com/articles/publish-your-artifacts-to-maven-central](https://web.archive.org/web/20230324135530/https://dzone.com/articles/publish-your-artifacts-to-maven-central)
or execute these steps:
```sh
gpg --full-gen-key
> Select RSA and RSA
> 4096
> 0 (does not expire)
# The key ID is the pub key ID
> gpg –keyserver keys.pgp.net –send-key [KEY_ID]
```
On macOS, use GPG Keychain as gpg `--full-gen-key` may run into issues.
1. Use this value for `MVN_GPG_ASC_BASE64`:
`gpg --pinentry-mode loopback --export-secret-keys --armor $MVN_PGP_KEY_ID | base64 -w0 | pbcopy`
2. Set `MVN_PGP_KEY_ID` to the value of the key ID (on MacOS you can find it in
the info section of GPG Keychain).
3. Set `MVN_PGP_KEYNAME` to the value of the public key fingerprint.
4. Set `MVN_PGP_PASSPHRASE` to the passphrase of the private key.
Then, run the following commands:
```shell script
mvn clean
# THESE VALUES ARE EXAMPLES - PLEASE PICK THE APPROPRIATE `tag`, etc
mvn -Dtag=client-0.0.1-alpha.1 release:update-version \
-DreleaseVersion=0.0.1-alpha.1 -DdevelopmentVersion=0.0.1-alpha.1-SNAPSHOT \
-Darguments="-Dmaven.javadoc.skip=true" -Dresume=false
mvn release:perform -Darguments="-Dmaven.javadoc.skip=true" -Dresume=false
```