Follow up: Regex properties on non-string types

[industrian]

Original issue: #1357

In a recent update, this functionality was added to the kit.

The description in a work-in-progress document appears to be "off" though:

It's "Array of Any object property matching this regular expression" when it should be "Array of Suggestion":

This was discussed at the Team weekly on 21 September.

[gabriele-ct]

Looking at api-specs/history/types/common/SearchKeywords.raml
seems that the expected structure is like this:

#%RAML 1.0 DataType
(package): Common
type: object
displayName: SearchKeywords
description:
properties:
  /^[a-z]{2}(-[A-Z]{2})?$/:
    type: array
    items:
      type: SearchKeyword

Could @industrian please check if the actual Product definition in api-specs/api/types/product/SuggestionResult.raml is correct of is missing the type property

[industrian]

Looking at api-specs/history/types/common/SearchKeywords.raml seems that the expected structure is like this:

#%RAML 1.0 DataType
(package): Common
type: object
displayName: SearchKeywords
description:
properties:
  /^[a-z]{2}(-[A-Z]{2})?$/:
    type: array
    items:
      type: SearchKeyword

Could @industrian please check if the actual Product definition in api-specs/api/types/product/SuggestionResult.raml is correct of is missing the type property

I tested the following and got the same result.

#%RAML 1.0 DataType
(package): Product
(docs-uri): https://docs.commercetools.com/api/projects/products-suggestions#suggestionresult
displayName: SuggestionResult
type: object
properties:
  /searchKeywords.[a-z]{2}(-[A-Z]{2})?/:
    type: array
    items:
      type: Suggestion

[stmeissner]

@gabriele-ct In particular it's in file /api-specs/api/types/product/SuggestionResult.raml

#%RAML 1.0 DataType
(package): Product
displayName: SuggestionResult
type: object
properties:
  /searchKeywords.[a-z]{2}(-[A-Z]{2})?/:
    type: array
    items: Suggestion
    description: Results of a suggestion.

What we would like to have is

Array of Suggestion

with Suggestion being a link to the rendered type.

Currently we are getting

Array of Any object property matching this regular expression.

[timonrey]

ramldoc output for this case:

#%RAML 1.0 DataType
displayName: SuggestionResult
type: object
(builtinType): object
(package): "Product"
(docs-uri): "https://docs.commercetools.com/http-api-projects-products-suggestions.html#suggestionresult"
properties:
  /searchKeywords.[a-z]{2}(-[A-Z]{2})?/:
    type: array
    items:
      type: Suggestion
    (builtinType): array
    required: true
    (inherited): false

We need to apply the same logic for the regex types as we do for the other types to display the right type.
Link to the code:

commercetools-docs-kit/packages/gatsby-theme-api-docs/src/components/type/properties/rows/name-type.js

Line 61 in 558ae40

? `Any ${typeof typeToRender.type} property matching this regular expression`