Schema names special symbols

[Warxcell]

API Platform version(s) affected: 2.5.4

Description
Either SwaggerHub.com or OpenAPI Generator likes special symbols:

SwaggerHub.com
$ref values must be RFC3986-compliant percent-encoded URIs

OpenAPI Generator
-attribute components.schemas.Schema name VendorCategory:jsonld doesn't adhere to regular expression ^[a-zA-Z0-9\.\-_]+$

How to reproduce
Use OpenAPI Generator or online software : swaggerhub.com

Possible Solution
Do not use special symbols or urlencode Schema names

Additional Context

[rcidaleassumpo]

Anyone ?

[hmolsen]

same problem here.

openapi: 3.0.2
paths:
  /api/resource_names:
    post:
      tags:
        - ResourceName
      operationId: postResourceNamesCollection
      summary: 'Creates a Resource Name resource.'
      responses:
        201:
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/ResourceNames:jsonld-resource_names:read'

results in

Semantic error at paths./api/resource_names.post.responses.201.content.application/ld+json.schema.$ref
$ref values must be RFC3986-compliant percent-encoded URIs
Jump to line 14

in https://editor.swagger.io/

This is the recommended way of grouping operations (e.g., resource_name:read).

Temporary workaround:
You can work around this by manually renaming each definition. But that's not really a practical solution.

https://api-platform.com/docs/core/swagger/#changing-the-name-of-a-definition

[yakobe]

@dunglas it would be awesome if you could you take a quick look at this if you get a chance? At the moment we cannot use the OpenAPI Generator with API platform and we are wondering which library needs to address it.

If there is any way to help, let us know and we will try to contribute 🙂

[Swahjak]

I'm not a 100% sure this is part of the same issue, but it seems to have the same origin. When generating using openapi-generator-cli generate -i https://endpoint/docs.json -g typescript-angular this results in some unexpected issues. As an example hydra:member is being typed as hydramember: Array<...> instead of 'hydra:member': Array<...> resulting in an unusable model. I'm not sure whether this is to blame on the generator or the docs.

Edit: this was an incorrect assumption and doesn't contribute to the discussion. Opened a issue for typescript generation in openapi-generator OpenAPITools/openapi-generator#6810

[Swahjak]

I think my previous comment might have been to soon after some further research (excuse me if it is), but I did find out that replacing src/JsonSchema/SchemaFactory.php:218 and src/JsonSchema/SchemaFactory.php:223 from $prefix .= ':'... to $prefix .= '.'... does fix the RFC3986-compliant error. I'm not sure if there are any side effects (yet).

[Swahjak]

Also, it seems that this has been discussed before in #1969

[stchr]

Should be fixed with #3669