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

[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:

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:

The same also happens on dropdown types:

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 😄

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[ramyaparimi]

@ciaranevans
Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

[docubot]

Thank you for opening this issue! Changes to the REST API schema can be requested in github/rest-api-description. I will transfer your issue over to that open source repo.

[ciaransweet]

@ramyaparimi I'm not sure this was moved correctly, the issue is indeed in the GitHub docs directory? Or is this moved because the implementation on the API is wrong against the docs?

[ramyaparimi]

@ciaranevans This is something that's fixed internally so your issue has been transferred to an internal repo 👍

[ciaransweet]

@ramyaparimi got you, thanks for clarifying!

[skedwards88]

👋 Apologies for mis-transferring this! This can be fixed in the public docs repo, so I am going to transfer it back.

Thank you for the detailed issue about how to reproduce the error!

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 😄

The docs should be fixed here 😄 You or anyone else is welcome to open a PR to fix this issue.

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[thispsj]

@skedwards88 I got this and will send in a PR soon.

Hey, I sent a PR.