Skip to content

Commit

Permalink
Update upgrade guide (#337)
Browse files Browse the repository at this point in the history
  • Loading branch information
aeneasr authored Jan 13, 2020
1 parent 2e13a05 commit 99e9877
Show file tree
Hide file tree
Showing 10 changed files with 43 additions and 12 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ sdk:
$$(go env GOPATH)/bin/swagger generate client -f ./docs/api.swagger.json -t internal/httpclient -A Ory_Oathkeeper
make format


.PHONY: install-stable
install-stable:
OATHKEEPER_LATEST=$$(git describe --abbrev=0 --tags)
Expand Down
31 changes: 29 additions & 2 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ before finalizing the upgrade process.
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [master](#master)

- [v0.35.0-beta.1](#v0350-beta1)
- [v0.34.0-beta.1+oryOS.14](#v0340-beta1oryos14)
- [v0.33.0-beta.1+oryOS.13](#v0330-beta1oryos13)
- [v0.32.0-beta.1+oryOS.12](#v0320-beta1oryos12)
- [v0.19.0-beta.1+oryOS.12](#v0190-beta1oryos12)
- [Config Changes](#config-changes)
- [Hydrator Mutator](#hydrator-mutator)
Expand Down Expand Up @@ -42,7 +46,30 @@ before finalizing the upgrade process.

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## master
## v0.35.0-beta.1

This release focuses on a rework of the SDK pipeline. First of all, we have introduced new SDKs for all popular programming
languages and published them on their respective package repositories:

- [Python](https://pypi.org/project/ory-oathkeeper-client/)
- [PHP](https://packagist.org/packages/ory/oathkeeper-client)
- [Go](https://github.com/ory/oathkeeper-client-go)
- [NodeJS](https://www.npmjs.com/package/@oryd/oathkeeper-client) (with TypeScript)
- [Java](https://search.maven.org/artifact/sh.ory.oathkeeper/oathkeeper-client)
- [Ruby](https://rubygems.org/gems/ory-oathkeeper-client)

The SDKs hosted in this repository (under ./sdk/...) have been completely removed. Please use only the SDKs from the
above sources from now on as it will also remove several issues that were caused by the previous SDK pipeline.

Unfortunately, there were breaking changes introduced by the new SDK generation:

- Several structs and fields have been renamed in the Go SDK. However, nothing else changed so upgrading should be a matter of
half an hour if you made extensive use of the SDK, or several minutes if just one or two methods are being used.
- All other SDKs changed to `openapi-generator`, which is a better maintained generator that creates
better code than the one previously used. This manifests in TypeScript definitions for the NodeJS SDK and
several other goodies. We do not have a proper migration path for those, unfortunately.

If you have issues with upgrading the SDK, please let us know in an issue on this repository!

## v0.34.0-beta.1+oryOS.14

Expand Down
9 changes: 7 additions & 2 deletions docs/api.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -518,7 +518,7 @@
},
"definitions": {
"Upstream": {
"description": "Upstream Upstream upstream",
"description": "Upstream Upstream Upstream upstream",
"type": "object",
"properties": {
"preserve_host": {
Expand Down Expand Up @@ -548,6 +548,7 @@
}
},
"healthStatus": {
"description": "HealthStatus health status",
"type": "object",
"properties": {
"status": {
Expand All @@ -557,7 +558,7 @@
}
},
"jsonWebKey": {
"description": "JSONWebKey JSONWebKey json web key",
"description": "JSONWebKey JSONWebKey JSONWebKey json web key",
"type": "object",
"properties": {
"alg": {
Expand Down Expand Up @@ -634,6 +635,7 @@
}
},
"jsonWebKeySet": {
"description": "JSONWebKeySet json web key set",
"type": "object",
"properties": {
"keys": {
Expand Down Expand Up @@ -683,6 +685,7 @@
}
},
"ruleHandler": {
"description": "RuleHandler rule handler",
"type": "object",
"properties": {
"config": {
Expand All @@ -696,6 +699,7 @@
}
},
"ruleMatch": {
"description": "RuleMatch rule match",
"type": "object",
"properties": {
"methods": {
Expand All @@ -712,6 +716,7 @@
}
},
"version": {
"description": "Version version",
"type": "object",
"properties": {
"version": {
Expand Down
2 changes: 1 addition & 1 deletion internal/httpclient/models/health_status.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/httpclient/models/json_web_key.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/httpclient/models/json_web_key_set.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/httpclient/models/rule_handler.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/httpclient/models/rule_match.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/httpclient/models/upstream.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion internal/httpclient/models/version.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 99e9877

Please sign in to comment.