Skip to content

Commit 949986e

Browse files
authored
Merge pull request #662 from lukaszbudnik/feat/doc-clean-up
feat: documentation clean up
2 parents 6c52849 + 513a091 commit 949986e

File tree

5 files changed

+10
-320
lines changed

5 files changed

+10
-320
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
runs-on: ubuntu-latest
88
strategy:
99
matrix:
10-
go: [ '1.25', '1.24' ]
10+
go: [ '1.25' ]
1111
name: Go ${{ matrix.go }}
1212

1313
steps:

APIv1.md

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

README.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -393,12 +393,6 @@ See [Quick Start Guide](#-quick-start-guide) for a few curl examples to get you
393393

394394
The preferred way of consuming migrator's GraphQL endpoint is to use GraphQL clients. These clients can be generated from the GraphQL schema in any programming language you use (Java, Python, C#, JavaScript, Go, etc.).
395395

396-
### /v1 - REST API
397-
398-
API v1 was sunset in v2021.0.0.
399-
400-
The documentation is available in a separate document [API v1](APIv1.md).
401-
402396
### Request tracing
403397

404398
migrator uses request tracing via `X-Request-ID` header. This header can be used with all requests for tracing and/or auditing purposes. If this header is absent migrator will generate one for you.
@@ -449,7 +443,7 @@ port: 8080
449443
# path prefix is optional and defaults to '/'
450444
# path prefix is used for application HTTP request routing by Application Load Balancers/Application Gateways
451445
# for example when deploying to AWS ECS and using AWS ALB the path prefix could be set as below
452-
# then all HTTP requests should be prefixed with that path, for example: /migrator/v1/config, /migrator/v1/migrations/source, etc.
446+
# then all HTTP requests should be prefixed with that path, for example: /migrator/v2/config, /migrator/v2/service, etc.
453447
pathPrefix: /migrator
454448
# the webhook configuration section is optional
455449
# the default Content-Type header is application/json but can be overridden via webHookHeaders below
@@ -518,7 +512,7 @@ baseLocation: s3://your-bucket-migrator
518512
baseLocation: s3://your-bucket-migrator/appcodename/prod/artefacts
519513
```
520514

521-
migrator uses official AWS SDK for Go and uses a well known [default credential provider chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html).
515+
migrator uses official AWS SDK for Go v2 and uses [Auth schema resolution workflow](https://docs.aws.amazon.com/sdk-for-go/v2/developer-guide/configure-auth.html#auth-scheme-resolution-workflow).
522516

523517
### Azure Blob Containers
524518

@@ -531,7 +525,7 @@ baseLocation: https://storageaccountname.blob.core.windows.net/mycontainer
531525
baseLocation: https://storageaccountname.blob.core.windows.net/mycontainer/appcodename/prod/artefacts
532526
```
533527

534-
migrator uses official Azure SDK for Go and supports authentication using Storage Account Key (via `AZURE_STORAGE_ACCOUNT` and `AZURE_STORAGE_ACCESS_KEY` env variables) as well as much more flexible (and recommended) Azure Active Directory Managed Identity.
528+
migrator uses official Azure SDK for Go and uses [Azure Identity library](https://learn.microsoft.com/en-us/azure/developer/go/sdk/authentication/authentication-overview).
535529

536530
## 🗄️ Supported databases
537531

server/server.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,11 @@ func SetupRouter(r *gin.Engine, versionInfo *types.VersionInfo, config *config.C
188188

189189
r.GET(config.PathPrefix+"/health", makeHandler(config, metrics, newCoordinator, healthHandler))
190190

191+
v1 := r.Group(config.PathPrefix + "/v1")
192+
v1.Any("/*any", func(c *gin.Context) {
193+
c.Status(http.StatusGone)
194+
})
195+
191196
v2 := r.Group(config.PathPrefix + "/v2")
192197
v2.GET("/config", makeHandler(config, metrics, newCoordinator, configHandler))
193198
v2.GET("/schema", makeHandler(config, metrics, newCoordinator, schemaHandler))

server/server_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ func TestConfigRoute(t *testing.T) {
152152
router.ServeHTTP(w, req)
153153

154154
// v1 is now removed
155-
assert.Equal(t, http.StatusNotFound, w.Code)
155+
assert.Equal(t, http.StatusGone, w.Code)
156156
}
157157

158158
// /v2 API

0 commit comments

Comments
 (0)