Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add note to disambiguate between Ory Network and Ory self-hoste… #329

Merged
merged 1 commit into from
Feb 16, 2024
Merged

feat: add note to disambiguate between Ory Network and Ory self-hoste… #329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# Generated SDKs for the ORY Ecosystem
# 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
Expand Down
2 changes: 2 additions & 0 deletions config/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This is the official Ory ${PROJECT_UCF} SDK for ${LANG}.

${NETWORK_OR_SELFHOSTED}

Please do not make any pull requests against this repository! Its contents are
fully auto-generated by the [ory/sdk](http://github.com/ory/sdk) repository. Any
changes to this repository will be overwritten on the next CI run!
Expand Down
14 changes: 14 additions & 0 deletions scripts/prep.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,13 @@ export ELIXIR_PACKAGE_NAME="ory_${PROJECT}"

export GIT_REPO="${PROJECT}-client"

export NETWORK_OR_SELFHOSTED="## Ory Self-Hosted

This SDK is for use with self-hosted Ory ${PROJECT_UCF}.
If you are developing against Ory Network, please use the [Ory Network SDK](https://www.ory.sh/docs/sdk).

"

if [ $project == "client" ]; then
export DART_PUB_NAME=ory_client
export DOTNET_PACKAGE_NAME="Ory.Client"
Expand All @@ -111,4 +118,11 @@ if [ $project == "client" ]; then
export ELIXIR_PACKAGE_NAME="ory_client"

export GIT_REPO="client"
export NETWORK_OR_SELFHOSTED="## Ory Network

This SDK is for use with [Ory Network](https://www.ory.sh/docs/sdk).
If you are developing aginst a self-hosted Ory instance, please use the individual ${PROJECT_UCF} SDK
and refer to the [self-hosted documentation](https://www.ory.sh/docs/sdk/self-hosted).

"
fi
Loading