Skip to content

Syntax for GitHub's form schema is incorrect with relation to IDs #9004

Closed
@ciaransweet

Description

@ciaransweet

Code of Conduct

  • I have read and agree to the GitHub Docs project's Code of Conduct.

What article on docs.github.com is affected?

https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema

What part(s) of the article would you like to see updated?

When trialling out the .yaml issue form templates, I came across the following error:
image

As you can see, it states that: body[0]: id is not a permitted attribute.

Yet here: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4, id is explicitly an allowed attribute. If I move the ID to the type/attributes level of the checkboxes entry I get:

image

The same also happens on dropdown types:

image

I would assume the same is for all types that have id listed as an attribute.

Additional information

I'd be happy to raise a PR to change the docs, but I'm not sure if the docs are right and the implementation is wrong, or the implementation is right and the docs are wrong 😄

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions