Skip to content

CRD documentation isn't correctly represeting array of struct types #2393

@a-hilaly

Description

@a-hilaly

Right now, our docs are showing complex configs like they're single items, when they're actually meant to be arrays of structs. e.g in S3 bucket.spec.notifications - it looks like we're not showing users can set up multiple notifications.

How it's shown today:

  topicConfigurations:
    events:
    - string
    filter: 
      key: 
        filterRules:
        - name: string
          value: string
    id: string
    topicARN: string

How it should look like:

topicConfigurations:
  - events:
    - string
    filter: 
      key: 
        filterRules:
        - name: string
          value: string
    id: string
    topicARN: string

https://aws-controllers-k8s.github.io/community/reference/s3/v1alpha1/bucket/

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/documentationIssues or PRs related to documentation and exampleskind/bugCategorizes issue or PR as related to a bug.lifecycle/rottenDenotes an issue or PR that has aged beyond stale and will be auto-closed.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions