Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structs that allow any properties do not have any information shown #550

Open
Chriscbr opened this issue Jan 8, 2022 · 0 comments
Open
Labels
blocked Work is blocked on this issue for this codebase. Other labels or comments may indicate why. bug This issue is a bug.

Comments

@Chriscbr
Copy link
Contributor

Chriscbr commented Jan 8, 2022

To see an example of this, visit https://constructs.dev/packages/construct-hub/v/0.3.192/ and go to the API reference for DenyListMap.

The page should show some kind of information to indicate that any field is allowed, per the original source code:

/**
 * The contents of the deny list file in S3.
 */
export interface DenyListMap {
  /**
   * A map from "name@version" to deny list rule.
   */
  readonly [key: string]: DenyListRule;
};

It looks like the root cause is that this information does not get saved in any form in the generated .jsii file (most other structs have a "properties" field with a list of the supported properties):

"construct-hub.DenyListMap": {
  "assembly": "construct-hub",
  "datatype": true,
  "docs": {
    "stability": "experimental",
    "summary": "The contents of the deny list file in S3."
  },
  "fqn": "construct-hub.DenyListMap",
  "kind": "interface",
  "locationInModule": {
    "filename": "src/backend/deny-list/api.ts",
    "line": 29
  },
  "name": "DenyListMap",
  "symbolId": "src/backend/deny-list/api:DenyListMap"
},

I think this is blocked until aws/jsii#2928 is resolved (since we would need a way to represent this kind of type in other languages).

@Chriscbr Chriscbr added blocked Work is blocked on this issue for this codebase. Other labels or comments may indicate why. bug This issue is a bug. labels Feb 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked Work is blocked on this issue for this codebase. Other labels or comments may indicate why. bug This issue is a bug.
Projects
None yet
Development

No branches or pull requests

1 participant