Skip to content

Commit

Permalink
Merge pull request #302 from bavix/vitepress
Browse files Browse the repository at this point in the history
Vitepress bugfixes
  • Loading branch information
rez1dent3 committed Jun 23, 2024
2 parents cbf0117 + 3328979 commit b2672c1
Show file tree
Hide file tree
Showing 11 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/guide/api/stubs/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Stubs List — endpoint returns a list of all registered stub files. It can be helpful to debbug your integration tests.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/api/stubs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Stubs Search — endpoint helps to flexibly search for stubs in the stub storage.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down Expand Up @@ -71,6 +71,6 @@ Response:
}
```

[Input Matching](../../../../docs_old/matching-rule-input.md ':include')
<!--@include: ../../matcher/input.md -->

[Headers Matching](../../../../docs_old/matching-rule-headers.md ':include')
<!--@include: ../../matcher/headers.md -->
2 changes: 1 addition & 1 deletion docs/guide/api/stubs/unused-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Stubs Unused List — endpoint returns a list of unused stubs (all stubs that we
A very useful method that helps find dead stubs in the code.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/api/stubs/upsert.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Stub API. Stubs Upsert

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/api/stubs/used-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Stubs Used List — endpoint returns a list of used stubs (all stubs that were f
The method inverts the logic of unused operation.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/introduction/quick-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ I will skip the details of installing docker and using it. Read documentation: h
Let's imagine that we have a gRPC service that we want to mock.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/matcher/headers.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Headers can consist of a key and a value. If there are several values, then you
**Gripmock** recursively goes over the fields and tries to match with given input.
<br>

## Equals
## Header Equals

**equals** will match the exact field name and value of input into expected stub. example stub JSON:
```json
Expand All @@ -38,7 +38,7 @@ Headers can consist of a key and a value. If there are several values, then you
}
```

## Contains
## Header Contains

**contains** will match input that has the value declared expected fields. example stub JSON:
```json
Expand All @@ -55,7 +55,7 @@ Headers can consist of a key and a value. If there are several values, then you
}
```

## Matches
## Header Matches

**matches** using regex for matching fields expectation. example:

Expand Down
8 changes: 4 additions & 4 deletions docs/guide/matcher/input.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Nested fields are allowed for input matching too for all JSON data types. (`stri
**Gripmock** recursively goes over the fields and tries to match with given input.
<br>

## Equals
## Input Equals

**equals** will match the exact field name and value of input into expected stub. example stub JSON:
```json
Expand All @@ -44,7 +44,7 @@ Nested fields are allowed for input matching too for all JSON data types. (`stri
}
```

## Contains
## Input Contains

**contains** will match input that has the value declared expected fields. example stub JSON:
```json
Expand All @@ -64,7 +64,7 @@ Nested fields are allowed for input matching too for all JSON data types. (`stri
}
```

## Matches
## Input Matches

**matches** using regex for matching fields expectation. example:

Expand All @@ -83,7 +83,7 @@ Nested fields are allowed for input matching too for all JSON data types. (`stri
}
```

## Flag ignoreArrayOrder
## Input Flag ignoreArrayOrder

**ignoreArrayOrder** Disables sorting check inside arrays.
```yaml
Expand Down
6 changes: 3 additions & 3 deletions docs/guide/stubs/benefits-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,22 +99,22 @@ You know these standards, right? Each developer starts creating their own guide
Yes, Yes. I even had to do something like this: https://bavix.github.io/uuid-ui/
Option 1:
```protobuf
```proto
message .... {
bytes uuid = 1;
}
```

Option 2:
```protobuf
```proto
message UUID {
int64 high = 1;
int64 low = 2;
}
```

Option 3 (there is such an implementation, but so far it is not in the functions):
```protobuf
```proto
message UUID {
uint64 high = 1;
uint64 low = 2;
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/stubs/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ It can also be useful when there are a lot of stubs.
So what do you need to work? It is enough to mount a folder with stubs in your container and tell the service the path to the stubs.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/stubs/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ It can also be useful when there are a lot of stubs.
So what do you need to work? It is enough to mount a folder with stubs in your container and tell the service the path to the stubs.

Let's imagine that our contract `simple.proto` looks something like this:
```protobuf
```proto
syntax = "proto3";
option go_package = "github.com/bavix/gripmock/protogen/example/simple";
Expand Down

0 comments on commit b2672c1

Please sign in to comment.