Roblox · API Governance Rules

Roblox — creator docs rules

Spectral linting rules defining API design standards and conventions for Roblox.

5 Rules error 4 warn 1
Published by Roblox Served by the provider at https://github.com/Roblox/creator-docs/blob/4fc8478587ee7c1a412403d76baff4d0ede578d4/tools/checks/utils/openapi/spectral.yml; the copy below was fetched from there.
View Rules File View on GitHub

Rule Categories

server servers

Rules

error
servers-required
OpenAPI specification must have a 'servers' field with at least one server
$
error
servers-not-empty
Servers array must contain at least one server
$.servers
error
server-url-required
Each server must have a 'url' field
$.servers[*]
warn
server-url-https
Server URLs should use HTTPS for security
$.servers[*].url
error
server-url-domain
Server URLs should point to roblox.com domains or localhost
$.servers[*].url

Spectral Ruleset

roblox-creator-docs-spectral-rules.yml Raw ↑
# harvested from https://github.com/Roblox/creator-docs/blob/4fc8478587ee7c1a412403d76baff4d0ede578d4/tools/checks/utils/openapi/spectral.yml on 2026-10-09 — a Spectral ruleset published in the provider's own GitHub repository (Roblox/creator-docs); found by GitHub code search, fetched verbatim
x-method: harvested
x-stamped: 2026-10-09
x-source-url: https://github.com/Roblox/creator-docs/blob/4fc8478587ee7c1a412403d76baff4d0ede578d4/tools/checks/utils/openapi/spectral.yml
# Simple Spectral OpenAPI Validation Rules for Testing
extends:
  - spectral:oas # Built-in OpenAPI v2/v3 rules

rules:
  # @neoxu (2025-09-01): Change the severity from error to warn because the existing docs have too many of this kind of error and it doesn't impact functionality. https://meta.stoplight.io/docs/spectral/4dec24461f3af-open-api-rules#no-ref-siblings
  no-$ref-siblings: warn
  oas3-valid-schema-example: warn
  path-params: warn
  # Require servers field to be present and non-empty
  servers-required:
    description: "OpenAPI specification must have a 'servers' field with at least one server"
    given: '$'
    severity: error
    then:
      field: servers
      function: truthy

  servers-not-empty:
    description: 'Servers array must contain at least one server'
    given: '$.servers'
    severity: error
    then:
      function: length
      functionOptions:
        min: 1

  # Validate each server has required URL field
  server-url-required:
    description: "Each server must have a 'url' field"
    given: '$.servers[*]'
    severity: error
    then:
      field: url
      function: truthy

  # Basic URL pattern validation using built-in pattern function
  server-url-https:
    description: 'Server URLs should use HTTPS for security'
    given: '$.servers[*].url'
    severity: warn
    then:
      function: pattern
      functionOptions:
        match: '^https://'

  # Validate server URLs point to roblox.com or localhost
  server-url-domain:
    description: 'Server URLs should point to roblox.com domains or localhost'
    given: '$.servers[*].url'
    severity: error
    then:
      function: pattern
      functionOptions:
        match: "^https?://(.*\\.)?roblox\\.com|https?://localhost|https?://127\\.0\\.0\\.1"

Work with this as data

Every ruleset here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This ruleset
curl "https://apis.io/api/v1/rules/roblox-creator-docs-spectral-rules"
All spectral rules
curl "https://apis.io/api/v1/rules?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.