Documentation should specify whether a security label only applies to reads / writes of a property

Abcreator · December 22, 2024, 5:59pm

As a Roblox developer, I would like to see documentation on whether a property’s security restrictions (RobloxScript, LocalUser, Plugin, NotAccessible, etc.) are applied to reads, writes or both of these actions.

Currently, the documentation does not specify this and throws the entire property under the label, see:

As you can see from both these pages (which are just examples, there are likely way more of these cases); if you were to not read the descriptions, you’d be entirely under the impression that you cannot access these properties in any form. Just before this, I was actually going to make a bug-report to say that the descriptions must’ve been wrong because of the security labels saying that you can’t access them… I only then realised that, yes, you can read from them; you just can’t write to them.

Some external community-created resources display this info (see here for an example) and it has turned out to be incredibly beneficial for me. On top of this, the yaml file, which is presumably used to generate these pages, includes this info already so there shouldn’t be any extra info required to be entered other than needing to parse this existing info into a visual element of some form.

github.com

Roblox/creator-docs/blob/cb04623232d6bd5162f0df2865ada6f961265e82/content/en-us/reference/engine/classes/GamepadService.yaml#L34-L36


      
          security:
            read: None
            write: RobloxScriptSecurity

naahchos · July 8, 2025, 8:24pm

Hi @Abcreator. Just following up in this thread regarding the feature request to make our API security tags more explicit regarding read/write perms. Responding here to make sure the loop is closed and that you have a response in this thread that anyone can reference in the future.

I’ve checked with the team and got the request to them. While you’re correct that the data is included in the YAML (and there are many endpoints that can benefit from this), I don’t have a timeline for when we can get this updated on the docs site. Hopefully they can fold it into their roadmap sooner than later

Thanks again for requesting this! Have a great rest of your week.
Naahchos.