api/schema: rename AssertSchema to AssertRequestSchema

Author: ttaylorr

api/lock_api_test.go

@@ -14,7 +14,7 @@ var LockService api.LockService
 func TestSuccessfullyObtainingALock(t *testing.T) {
 	got, body := LockService.Lock(new(api.LockRequest))
 
-	AssertSchema(t, &api.RequestSchema{
+	AssertRequestSchema(t, &api.RequestSchema{
 		Method: http.MethodPost,
 		Path:   "/locks",
 		Body:   new(api.LockRequest),
@@ -30,7 +30,7 @@ func TestLockSearchWithFilters(t *testing.T) {
 		},
 	})
 
-	AssertSchema(t, &api.RequestSchema{
+	AssertRequestSchema(t, &api.RequestSchema{
 		Method: http.MethodGet,
 		Query: map[string]string{
 			"branch": "master",
@@ -46,7 +46,7 @@ func TestLockSearchWithNextCursor(t *testing.T) {
 		Cursor: "some-lock-id",
 	})
 
-	AssertSchema(t, &api.RequestSchema{
+	AssertRequestSchema(t, &api.RequestSchema{
 		Method: http.MethodGet,
 		Query: map[string]string{
 			"cursor": "some-lock-id",
@@ -61,7 +61,7 @@ func TestLockSearchWithLimit(t *testing.T) {
 		Limit: 20,
 	})
 
-	AssertSchema(t, &api.RequestSchema{
+	AssertRequestSchema(t, &api.RequestSchema{
 		Method: http.MethodGet,
 		Query: map[string]string{
 			"limit": "20",

api/request_schema_test.go

@@ -7,19 +7,17 @@ import (
 	"github.com/github/git-lfs/vendor/_nuts/github.com/stretchr/testify/assert"
 )
 
-// SchemaTestCase encapsulates a single assertion of equality against two
+// AssertRequestSchema encapsulates a single assertion of equality against two
 // generated RequestSchema instances.
 //
-// SchemaTestCases are meant only to test that the request schema generated by
-// an API service matches what we expect it to be. A SchemaTestCase does not
-// make use of the *api.Client, any particular lifecycle, or spin up a test
-// server. All of that behavior is tested at a higher strata in the
-// client/lifecycle tests.
-//
-// For examples, open any `*_api_test.go` file in the `api_test` package.
+// This assertion is meant only to test that the request schema generated by an
+// API service matches what we expect it to be. It does not make use of the
+// *api.Client, any particular lifecycle, or spin up a test server. All of that
+// behavior is tested at a higher strata in the client/lifecycle tests.
 //
+//   - t is the *testing.T used to preform the assertion.
 //   - Expected is the *api.RequestSchema that we expected to be generated.
 //   - Got is the *api.RequestSchema that was generated by a service.
-func AssertSchema(t *testing.T, expected, got *api.RequestSchema) {
+func AssertRequestSchema(t *testing.T, expected, got *api.RequestSchema) {
 	assert.Equal(t, expected, got)
 }