Skip to content

Commit d17d225

Browse files
authored
rename /schema endpoint to plural (#1263)
1 parent 0080fb5 commit d17d225

File tree

9 files changed

+20
-20
lines changed

9 files changed

+20
-20
lines changed

docs/api/README.md

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

internal/api/v2/controllers_schema_insert_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func TestInsertSchema(t *testing.T) {
9999
router := NewRouter(systemController, auth.NewNoAuth(), "develop")
100100

101101
body, _ := json.Marshal(tc.requestBody)
102-
req := httptest.NewRequest(http.MethodPost, "/default/schema/"+tc.version, bytes.NewBuffer(body))
102+
req := httptest.NewRequest(http.MethodPost, "/default/schemas/"+tc.version, bytes.NewBuffer(body))
103103
req.Header.Set("Content-Type", "application/json")
104104
rec := httptest.NewRecorder()
105105

internal/api/v2/controllers_schema_list_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ func TestListSchemas(t *testing.T) {
147147

148148
router := NewRouter(systemController, auth.NewNoAuth(), "develop")
149149

150-
req := httptest.NewRequest(http.MethodGet, "/default/schema?"+tc.queryParams.Encode(), nil)
150+
req := httptest.NewRequest(http.MethodGet, "/default/schemas?"+tc.queryParams.Encode(), nil)
151151
rec := httptest.NewRecorder()
152152

153153
router.ServeHTTP(rec, req)

internal/api/v2/controllers_schema_read_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ func TestGetSchema(t *testing.T) {
7878

7979
router := NewRouter(systemController, auth.NewNoAuth(), "develop")
8080

81-
req := httptest.NewRequest(http.MethodGet, "/default/schema/"+tc.version, nil)
81+
req := httptest.NewRequest(http.MethodGet, "/default/schemas/"+tc.version, nil)
8282
rec := httptest.NewRecorder()
8383

8484
router.ServeHTTP(rec, req)

internal/api/v2/routes.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ func NewRouter(
8282
))
8383
router.Get("/_info", getLedgerInfo)
8484
router.Get("/stats", readStats)
85-
router.Post("/schema/{version}", insertSchema)
86-
router.Get("/schema/{version}", readSchema)
87-
router.Get("/schema", listSchemas(routerOptions.paginationConfig))
85+
router.Post("/schemas/{version}", insertSchema)
86+
router.Get("/schemas/{version}", readSchema)
87+
router.Get("/schemas", listSchemas(routerOptions.paginationConfig))
8888

8989
if routerOptions.exporters {
9090
router.Route("/pipelines", func(router chi.Router) {

openapi.yaml

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

openapi/v2.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ paths:
178178
security:
179179
- Authorization:
180180
- ledger:write
181-
/v2/{ledger}/schema/{version}:
181+
/v2/{ledger}/schemas/{version}:
182182
parameters:
183183
- name: ledger
184184
in: path
@@ -252,7 +252,7 @@ paths:
252252
security:
253253
- Authorization:
254254
- ledger:read
255-
/v2/{ledger}/schema:
255+
/v2/{ledger}/schemas:
256256
parameters:
257257
- name: ledger
258258
in: path

pkg/client/.speakeasy/gen.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/client/v2.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -673,7 +673,7 @@ func (s *V2) InsertSchema(ctx context.Context, request operations.V2InsertSchema
673673
} else {
674674
baseURL = *o.ServerURL
675675
}
676-
opURL, err := utils.GenerateURL(ctx, baseURL, "/v2/{ledger}/schema/{version}", request, nil)
676+
opURL, err := utils.GenerateURL(ctx, baseURL, "/v2/{ledger}/schemas/{version}", request, nil)
677677
if err != nil {
678678
return nil, fmt.Errorf("error generating URL: %w", err)
679679
}
@@ -872,7 +872,7 @@ func (s *V2) GetSchema(ctx context.Context, request operations.V2GetSchemaReques
872872
} else {
873873
baseURL = *o.ServerURL
874874
}
875-
opURL, err := utils.GenerateURL(ctx, baseURL, "/v2/{ledger}/schema/{version}", request, nil)
875+
opURL, err := utils.GenerateURL(ctx, baseURL, "/v2/{ledger}/schemas/{version}", request, nil)
876876
if err != nil {
877877
return nil, fmt.Errorf("error generating URL: %w", err)
878878
}
@@ -1080,7 +1080,7 @@ func (s *V2) ListSchemas(ctx context.Context, request operations.V2ListSchemasRe
10801080
} else {
10811081
baseURL = *o.ServerURL
10821082
}
1083-
opURL, err := utils.GenerateURL(ctx, baseURL, "/v2/{ledger}/schema", request, nil)
1083+
opURL, err := utils.GenerateURL(ctx, baseURL, "/v2/{ledger}/schemas", request, nil)
10841084
if err != nil {
10851085
return nil, fmt.Errorf("error generating URL: %w", err)
10861086
}

0 commit comments

Comments
 (0)