WIP: Expand description of prefix map. #136
Conversation
At the first point that a prefix map is mentioned, extended the description and revised the example to show a URL-encoded prefix map.
| "required" : false, | ||
| "schema" : { | ||
| "type" : "string", | ||
| "format" : "JSON", | ||
| "example" : "{\"obo\": \"http://purl.obolibrary.org/obo/\", \"part_of\": \"http://purl.obolibrary.org/obo/BFO_0000050\"}" | ||
| "example" : "%7B%22obo%22%3A%20%22http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2F%22%2C%20%22part_of%22%3A%20%22http%3A%2F%2Fpurl.obolibrary.org%2Fobo%2FBFO_0000050%22%7D" |
There was a problem hiding this comment.
I don't think it's correct to URL-encode the example value. Any value would need to be URL-encoded in the actual request, and if you use the Swagger UI, it will do that for you.
There was a problem hiding this comment.
I was using curl and Postman, and both of them made me do the URL encoding myself. For curl there is the convenience argument --data-urlencode and Postman has a UI widget to do this. But in both cases it was down to me to understand that the URL-encoding was required. I think anyone who is working programmatically would have this problem (I don't believe that the openapi-generator would be smart enough to automate this).
BTW, I couldn't figure out how to use the UI. When I started up Owlery, I could not figure out how to get access to the Swagger page. I could get access to it from the Owlery GitHub repo, but that, of course, was not connected to my Owlery server.
|
Maybe this should be changed simply to note that the prefix map may need to be URL-encoded if your client (e.g., |
Note that this makes [pull request 136](phenoscape#136) obsolete.
|
Superseded by #205 (and made the requested change). |
At the first point that a prefix map is mentioned, extended the description and revised the example to show a URL-encoded prefix map.
I'm tagging this as WIP because I haven't been able to really test it, and because to improve it the prefix map entity should probably be defined as a component that can be used everywhere, instead of being replicated.