Skip to content

Commit 9bc31ae

Browse files
authored
docs: fix incorrect filename in BlogPostRequestConverter code block (#6510)
### Motivation While following Armeria’s REST tutorial, I was confused when reading this code block because the filename shown in the block was BlogRequestConverter.java, but the actual class inside the snippet was BlogPostRequestConverter. As a beginner, I initially thought I needed to create an additional class or that I was doing something wrong. <img width="755" height="255" alt="issue#6509" src="https://github.com/user-attachments/assets/3c0d09f3-d0a0-4bf0-9cfd-94a0a41fe716" /> To reduce such confusion for new users, I would like to fix this typo in the tutorial documentation. ### Modifications Updated the code block filename in armeria/site/src/pages/tutorials/rest/blog/implement-create.mdx from BlogRequestConverter.java to BlogPostRequestConverter.java. Before ``` java filename=BlogRequestConverter.java highlight=10-22 ... final class BlogPostRequestConverter implements RequestConverterFunction { ``` After ``` java filename="BlogPostRequestConverter.java" highlight=10-22 ... final class BlogPostRequestConverter implements RequestConverterFunction { ``` ### Result - Fixes a documentation typo and prevents confusion for new users following the REST tutorial. - No behavioral or code changes; documentation-only change - --- - - Closes #6509
1 parent 3230db8 commit 9bc31ae

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

site/src/pages/tutorials/rest/blog/implement-create.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ We can use Armeria's default <type://JacksonRequestConverterFunction> as is, but
5959

6060
1. Create a `BlogPostRequestConverter.java` file and declare a class, implementing the <type://RequestConverterFunction> interface. For the sake of simplicity, generate impromptu IDs for this tutorial.
6161

62-
```java filename=BlogRequestConverter.java
62+
```java filename=BlogPostRequestConverter.java
6363
package example.armeria.server.blog;
6464

6565
import com.fasterxml.jackson.databind.ObjectMapper;
@@ -74,7 +74,7 @@ We can use Armeria's default <type://JacksonRequestConverterFunction> as is, but
7474

7575
2. Add a method retrieving a value of a given key in a JSON object:
7676

77-
```java filename=BlogRequestConverter.java highlight=6-12
77+
```java filename=BlogPostRequestConverter.java highlight=6-12
7878
import com.fasterxml.jackson.databind.JsonNode;
7979

8080
final class BlogPostRequestConverter implements RequestConverterFunction {
@@ -92,7 +92,7 @@ We can use Armeria's default <type://JacksonRequestConverterFunction> as is, but
9292

9393
3. Customize the default `convertRequest()` method as follows.
9494

95-
```java filename=BlogRequestConverter.java highlight=10-22
95+
```java filename=BlogPostRequestConverter.java highlight=10-22
9696
import com.linecorp.armeria.server.ServiceRequestContext;
9797
import com.linecorp.armeria.common.AggregatedHttpRequest;
9898
import com.linecorp.armeria.common.annotation.Nullable;

0 commit comments

Comments
 (0)