Add @Consume(content-type) to all REST services class or methods

[ikhoon]

All Central Dogma APIs use JSON (Patch) to exchange data. A Central Dogma server can't handle other types such as XML or YAML.

Currently, the request content-type is not specified in some API methods.

centraldogma/server/src/main/java/com/linecorp/centraldogma/server/internal/api/ContentServiceV1.java

Lines 187 to 191 in 24603eb

	* <p>Pushes a commit.
	*/
	@Post("/projects/{projectName}/repos/{repoName}/contents")
	@RequiresWritePermission
	public CompletableFuture<PushResultDto> push(

That results in generating a converter not found error message if content-type is missing.
For example, a commit is sent without content-type, No suitable request converter is returned from which users don't know what is wrong.

$ curl -XPOST "http://127.0.0.1:36462/api/v1/projects/foo/repos/bar/contents" \
 -H "Authorization: Bearer appToken-***" \
 -d '{
    "commitMessage" : {
        "summary": "hello",
        "detail": "a",
        "markup": "MARKDOWN"
    },
    "changes" : [
        {
            "path" : "/foo0.json",
            "type" : "UPSERT_JSON",
            "content" : {"a": "bar2"}
        }
    ]
 }'
{"exception":"java.lang.IllegalArgumentException","message":"No suitable request converter found for a @RequestObject 'CommitMessageDto'"}%

If @ConsumeJson is added to the method, 405 Method Not Allowed is returned which would make it easier to identify the cause.

[chickenchickenlove]

@ikhoon nim, i want to take this task!
Could you assign this task to me?

[ikhoon]

Sure. Thanks for your interest!

[ikhoon]

#999 didn't handle all API. For example, we still need to specify @Consume to the below.

centraldogma/server/src/main/java/com/linecorp/centraldogma/server/internal/api/ProjectServiceV1.java

Lines 137 to 141 in a4e5893

	*/
	@Post("/projects")
	@StatusCode(201)
	@ResponseConverter(CreateApiResponseConverter.class)
	public CompletableFuture<ProjectDto> createProject(CreateProjectRequest request, Author author) {

[chickenchickenlove]

centraldogma/server/src/main/java/com/linecorp/centraldogma/server/internal/api/converter/CreateApiResponseConverter.java

Lines 53 to 66 in a4e5893

	try {
	final ResponseHeadersBuilder builder = headers.toBuilder();
	if (builder.contentType() == null) {
	builder.contentType(MediaType.JSON_UTF_8);
	}
	final JsonNode jsonNode = Jackson.valueToTree(resObj);
	if (builder.get(HttpHeaderNames.LOCATION) == null) {
	final String url = jsonNode.get("url").asText();
	// Remove the url field and send it with the LOCATION header.
	((ObjectNode) jsonNode).remove("url");
	builder.add(HttpHeaderNames.LOCATION, url);
	}

Sorry, i missed it.
May i create new PR to fix it?

[chickenchickenlove]

@ikhoon nim,
#999 didn't handle all API. For example, we still need to specify @consume to the below.

It seems that this code you mentioned is not about @ConsumesJson. 🤔
Since in this code, @ResponseConverter(not @RequestConverter) is used.
Thus, i think it is only related to @Produces.

centraldogma/server/src/main/java/com/linecorp/centraldogma/server/internal/api/ProjectServiceV1.java

Lines 137 to 141 in a4e5893

	*/
	@Post("/projects")
	@StatusCode(201)
	@ResponseConverter(CreateApiResponseConverter.class)
	public CompletableFuture<ProjectDto> createProject(CreateProjectRequest request, Author author) {

By the way, i took a look at more, i found this code.(@RequestConverter(CommitMessageRequestConverter.class).)
From this code, should we assume that all API in ContentServiceV1 require Content-type: json?

centraldogma/server/src/main/java/com/linecorp/centraldogma/server/internal/api/ContentServiceV1.java

Lines 101 to 104 in e78a569

	@ProducesJson
	@RequiresReadPermission
	@RequestConverter(CommitMessageRequestConverter.class)
	public class ContentServiceV1 extends AbstractService {

[ikhoon]

Central Dogma only uses JSON in REST APIs for the content-type.

CreateProjectRequest will be converted by the global JacksonRequestConverterFunction.

centraldogma/server/src/main/java/com/linecorp/centraldogma/server/CentralDogma.java

Line 775 in 534f6bf

new JacksonRequestConverterFunction(new ObjectMapper()),

If a content-type is not specified, JacksonRequestConverterFunction won't convert the body into CreateProjectRequest.