Google Forms · API Governance Rules
Google Forms API Rules
Spectral linting rules defining API design standards and conventions for Google Forms.
27 Rules
error 16
warn 10
info 1
Rule Categories
delete
get
info
no
openapi
operation
parameter
paths
response
schema
security
servers
tag
Rules
error
info-title-required
Info object must have a title
$.info
warn
info-title-prefix
Info title should start with Google Forms
$.info.title
error
info-description-required
Info object must have a description
$.info
error
info-version-required
Info object must have a version
$.info
error
openapi-version
OpenAPI version must be 3.0.x
$
error
servers-defined
Servers array must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
paths-kebab-case
Path segments should use kebab-case
$.paths
error
paths-no-trailing-slash
Paths must not have trailing slashes
$.paths
error
operation-summary-required
Operations must have a summary
$.paths[*][get,post,put,patch,delete]
error
operation-description-required
Operations must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Operations must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camel-case
operationId should be camelCase
$.paths[*][get,post,put,patch,delete].operationId
warn
operation-tags-required
Operations must have at least one tag
$.paths[*][get,post,put,patch,delete]
info
operation-summary-title-case
Operation summaries should start with Google Forms
$.paths[*][get,post,put,patch,delete].summary
warn
tag-title-case
Tag names should use Title Case
$.tags[*].name
warn
parameter-description-required
Parameters must have descriptions
$.paths[*][get,post,put,patch,delete].parameters[*]
error
parameter-schema-required
Parameters must have a schema
$.paths[*][get,post,put,patch,delete].parameters[*]
error
response-success-required
Operations must define a success response (2xx)
$.paths[*][get,post,put,patch,delete].responses
warn
response-401-required
Operations should define a 401 response
$.paths[*][get,post,put,patch,delete].responses
warn
schema-description-required
Top-level schemas should have descriptions
$.components.schemas[*]
warn
schema-type-required
Schemas should have a type defined
$.components.schemas[*]
error
security-global-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined
$.components
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
warn
delete-no-request-body
DELETE operations must not have a request body
$.paths[*].delete
error
no-empty-descriptions
Descriptions must not be empty strings
$.paths[*][get,post,put,patch,delete].description