search

Apicurio / apicurio-registry

An API/Schema registry - stores APIs and Schemas.
https://www.apicur.io/registry/
Apache License 2.0
607 stars 269 forks source link

Multi-byte support for titles in Upload Artifact screen. #1224

Open Yuutakasan opened 3 years ago

Yuutakasan commented 3 years ago

Multi-byte support for titles in Upload Artifact screen.

The Edit Artifact Meta-Data screen works fine even if the title contains Japanese (multibyte) characters.

step1 image step2 image

EricWittmann commented 3 years ago

We'll have to make this better, but please note that the "ID" of the artifact is not its name. The ID is the unique identifier of the artifact. You can leave that blank and the server will generate an ID for you. The Name can either be set separately in the UI or it will be extracted from the content itself (when possible).

The ID is used in the REST API when accessing the artifact. For example:

/api/artifacts/{artifactId}/versions/{version}

So in that case the value of the ID will need to be compatible with a URL path. I'm not sure if multi-byte characters are allowed in URLs.

@famartinrh any thoughts on this?

famarting commented 3 years ago

I modified the UI to do some basic validation and perform the URL encoding in the case of providing a artifactId, I will have to test it with this kind of characters with the latest version of the UI.

@Yuutakasan Hi, what version of Apicurio Registry were you using? I haven't verified it yet, but that issue may be fixed in master branch

Yuutakasan commented 3 years ago

@EricWittmann I may indeed have misunderstood. Since this field is an ID column, it might be better to fill it in with alphanumeric characters, or as you pointed out, specify empty, and the system will specify the UUID.

@famartinrh

Thanks for the fix. I am using Docker files from Docker hub. apicurio-registry-app-1.3.2.Final seems to be used.

The design intent is to not let the Upload Artifact screen specify the name, since the title is included in the file in the first place.

EricWittmann commented 3 years ago

OK it sounds like this is not a blocker for your use-case. But we'll still make sure the next version of the app constrains the ID to appropriate characters (if not already). :)

Yuutakasan commented 3 years ago

@EricWittmann Thank you. I think it would be better if the title item is displayed as a read-only item when uploading a file, so that people don't misunderstand it. Also, I think it would be more convenient if the label could be entered on the upload screen, so that you don't have to go through the input screen twice.