Microsoft Project · API Governance Rules

Microsoft Project API Rules

Spectral linting rules defining API design standards and conventions for Microsoft Project.

42 Rules error 23 warn 12 info 7
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Project's APIs. It is a starting point, not a ruleset Microsoft Project publishes or enforces.
View Rules File View on GitHub

Rule Categories

delete error get info microcks no openapi operation parameter paths post request response schema security servers tag tags uuid

Rules

error
info-title-required
Info object must have a title
$.info
warn
info-title-prefix
Title should start with "Microsoft Project"
$.info.title
error
info-description-required
Info object must have a description
$.info
warn
info-description-min-length
Info description should be at least 50 characters
$.info.description
error
info-version-required
Info object must have a version
$.info
warn
info-contact-required
Info object should have contact information
$.info
error
openapi-version
OpenAPI version should be 3.0.x
$.openapi
error
servers-defined
At least one server must be defined
$
error
servers-https
Server URLs must use HTTPS
$.servers[*].url
warn
servers-description
Each server should have a description
$.servers[*]
error
paths-no-trailing-slash
Paths must not end with a trailing slash
$.paths
error
paths-no-query-strings
Paths must not contain query strings
$.paths
error
operation-summary-required
Every operation must have a summary
$.paths[*][get,post,put,patch,delete]
warn
operation-summary-prefix
Operation summaries should start with "Microsoft Project"
$.paths[*][get,post,put,patch,delete].summary
error
operation-description-required
Every operation must have a description
$.paths[*][get,post,put,patch,delete]
error
operation-operationid-required
Every operation must have an operationId
$.paths[*][get,post,put,patch,delete]
warn
operation-operationid-camel-case
Operation IDs should use camelCase
$.paths[*][get,post,put,patch,delete].operationId
error
operation-tags-required
Every operation must have at least one tag
$.paths[*][get,post,put,patch,delete]
warn
tags-defined
Global tags array should be defined
$
info
tag-description
Each global tag should have a description
$.tags[*]
error
parameter-description-required
Every parameter must have a description
$..parameters[*]
error
parameter-schema-required
Every parameter must have a schema with a type
$..parameters[*]
error
parameter-path-required
Path parameters must be required
$..parameters[?(@.in == 'path')]
warn
request-body-json
Request bodies should use application/json content type
$.paths[*][post,put,patch].requestBody.content
error
response-success-required
Every operation must define a success response (2xx)
$.paths[*][get,post,put,patch,delete].responses
error
response-description-required
Every response must have a description
$.paths[*][get,post,put,patch,delete].responses[*]
info
response-401-defined
Operations should define a 401 Unauthorized response
$.paths[*][get,post,put,patch,delete].responses
error
schema-type-defined
All schemas must define a type
$.components.schemas[*]
info
schema-properties-pascal-case
Schema properties should use PascalCase (Microsoft convention)
$.components.schemas[*].properties
error
security-defined
Global security must be defined
$
error
security-schemes-defined
Security schemes must be defined in components
$.components
warn
security-oauth2-scheme
OAuth2 security scheme should be defined for SharePoint APIs
$.components.securitySchemes
error
get-no-request-body
GET operations must not have a request body
$.paths[*].get
error
delete-no-request-body
DELETE operations must not have a request body
$.paths[*].delete
info
post-request-body
POST operations should have a request body
$.paths[*].post
error
no-empty-descriptions
Descriptions must not be empty strings
$..description
info
schema-description
Top-level schemas should have descriptions
$.components.schemas[*]
info
uuid-format
GUID/UUID properties should use format uuid
$.components.schemas[*].properties[?(@.type == 'string' && @.description && /identifier|GUID|uuid/i.test(@.description))]
info
microcks-operation-extension
Operations should have x-microcks-operation for mock compatibility
$.paths[*][get,post,put,patch,delete]
warn
servers-expected-domain
Server URLs should be on the sharepoint.com domain.
$.servers[*].url
warn
schema-names-casing
Component schema names should be PascalCase (the dominant convention in this API).
$.components.schemas
warn
error-schema-defined
A shared error schema (Error) should be defined for error payloads.
$.components.schemas

Spectral Ruleset

Raw ↑ 
# authorship: generated by API Evangelist tooling. Stamped 2026-08-18
# on the file's own generator header (roadmap#64). An unmarked file is
# NOT assumed to be ours -- absence of evidence was never stamped.
x-method: generated
# microsoft-project — Spectral ruleset (strengthened)
# Plain Spectral. Existing hand-authored rules preserved; measured rules added
# from this provider's own OpenAPI conventions by strengthen_ruleset.py,
# then self-validated against the spec.
#
# Provenance:
#   - servers-https-only: 100% of servers already https (error)
#   - servers-expected-domain: 1/1 servers on sharepoint.com
#   - path-params-casing: camel @ 98% (n=49)
#   - operationid-casing: camel @ 100% (n=63)
#   - schema-names-casing: pascal @ 100% (n=54)
#   - schema-properties-casing: pascal @ 90% (n=184)
#   - security: global (root) — NOT emitting operation-security-required
#   - error-schema-defined: Error
#   - merge: kept 39 existing, added 3 measured, upgraded 0
#   - added: servers-expected-domain, schema-names-casing, error-schema-defined
extends:
  - spectral:oas
rules:
  info-title-required:
    description: Info object must have a title
    severity: error
    given: $.info
    then:
      field: title
      function: truthy
  info-title-prefix:
    description: Title should start with "Microsoft Project"
    severity: warn
    given: $.info.title
    then:
      function: pattern
      functionOptions:
        match: ^Microsoft Project
  info-description-required:
    description: Info object must have a description
    severity: error
    given: $.info
    then:
      field: description
      function: truthy
  info-description-min-length:
    description: Info description should be at least 50 characters
    severity: warn
    given: $.info.description
    then:
      function: length
      functionOptions:
        min: 50
  info-version-required:
    description: Info object must have a version
    severity: error
    given: $.info
    then:
      field: version
      function: truthy
  info-contact-required:
    description: Info object should have contact information
    severity: warn
    given: $.info
    then:
      field: contact
      function: truthy
  openapi-version:
    description: OpenAPI version should be 3.0.x
    severity: error
    given: $.openapi
    then:
      function: pattern
      functionOptions:
        match: ^3\.0\.
  servers-defined:
    description: At least one server must be defined
    severity: error
    given: $
    then:
      field: servers
      function: truthy
  servers-https:
    description: Server URLs must use HTTPS
    severity: error
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: ^https://
  servers-description:
    description: Each server should have a description
    severity: warn
    given: $.servers[*]
    then:
      field: description
      function: truthy
  paths-no-trailing-slash:
    description: Paths must not end with a trailing slash
    severity: error
    given: $.paths
    then:
      field: '@key'
      function: pattern
      functionOptions:
        notMatch: \/$
  paths-no-query-strings:
    description: Paths must not contain query strings
    severity: error
    given: $.paths
    then:
      field: '@key'
      function: pattern
      functionOptions:
        notMatch: \?
  operation-summary-required:
    description: Every operation must have a summary
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: summary
      function: truthy
  operation-summary-prefix:
    description: Operation summaries should start with "Microsoft Project"
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].summary
    then:
      function: pattern
      functionOptions:
        match: ^Microsoft Project
  operation-description-required:
    description: Every operation must have a description
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: description
      function: truthy
  operation-operationid-required:
    description: Every operation must have an operationId
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: operationId
      function: truthy
  operation-operationid-camel-case:
    description: Operation IDs should use camelCase
    severity: warn
    given: $.paths[*][get,post,put,patch,delete].operationId
    then:
      function: pattern
      functionOptions:
        match: ^[a-z][a-zA-Z0-9]*$
  operation-tags-required:
    description: Every operation must have at least one tag
    severity: error
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: tags
      function: truthy
  tags-defined:
    description: Global tags array should be defined
    severity: warn
    given: $
    then:
      field: tags
      function: truthy
  tag-description:
    description: Each global tag should have a description
    severity: info
    given: $.tags[*]
    then:
      field: description
      function: truthy
  parameter-description-required:
    description: Every parameter must have a description
    severity: error
    given: $..parameters[*]
    then:
      field: description
      function: truthy
  parameter-schema-required:
    description: Every parameter must have a schema with a type
    severity: error
    given: $..parameters[*]
    then:
      field: schema
      function: truthy
  parameter-path-required:
    description: Path parameters must be required
    severity: error
    given: $..parameters[?(@.in == 'path')]
    then:
      field: required
      function: truthy
  request-body-json:
    description: Request bodies should use application/json content type
    severity: warn
    given: $.paths[*][post,put,patch].requestBody.content
    then:
      field: application/json
      function: truthy
  response-success-required:
    description: Every operation must define a success response (2xx)
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      function: schema
      functionOptions:
        schema:
          anyOf:
          - required:
            - '200'
          - required:
            - '201'
          - required:
            - '204'
  response-description-required:
    description: Every response must have a description
    severity: error
    given: $.paths[*][get,post,put,patch,delete].responses[*]
    then:
      field: description
      function: truthy
  response-401-defined:
    description: Operations should define a 401 Unauthorized response
    severity: info
    given: $.paths[*][get,post,put,patch,delete].responses
    then:
      field: '401'
      function: truthy
  schema-type-defined:
    description: All schemas must define a type
    severity: error
    given: $.components.schemas[*]
    then:
      field: type
      function: truthy
  schema-properties-pascal-case:
    description: Schema properties should use PascalCase (Microsoft convention)
    severity: info
    given: $.components.schemas[*].properties
    then:
      field: '@key'
      function: pattern
      functionOptions:
        match: ^[A-Z][a-zA-Z0-9]*$
  security-defined:
    description: Global security must be defined
    severity: error
    given: $
    then:
      field: security
      function: truthy
  security-schemes-defined:
    description: Security schemes must be defined in components
    severity: error
    given: $.components
    then:
      field: securitySchemes
      function: truthy
  security-oauth2-scheme:
    description: OAuth2 security scheme should be defined for SharePoint APIs
    severity: warn
    given: $.components.securitySchemes
    then:
      field: oauth2
      function: truthy
  get-no-request-body:
    description: GET operations must not have a request body
    severity: error
    given: $.paths[*].get
    then:
      field: requestBody
      function: falsy
  delete-no-request-body:
    description: DELETE operations must not have a request body
    severity: error
    given: $.paths[*].delete
    then:
      field: requestBody
      function: falsy
  post-request-body:
    description: POST operations should have a request body
    severity: info
    given: $.paths[*].post
    then:
      field: requestBody
      function: truthy
  no-empty-descriptions:
    description: Descriptions must not be empty strings
    severity: error
    given: $..description
    then:
      function: truthy
  schema-description:
    description: Top-level schemas should have descriptions
    severity: info
    given: $.components.schemas[*]
    then:
      field: description
      function: truthy
  uuid-format:
    description: GUID/UUID properties should use format uuid
    severity: info
    given: $.components.schemas[*].properties[?(@.type == 'string' && @.description && /identifier|GUID|uuid/i.test(@.description))]
    then:
      field: format
      function: pattern
      functionOptions:
        match: uuid
  microcks-operation-extension:
    description: Operations should have x-microcks-operation for mock compatibility
    severity: info
    given: $.paths[*][get,post,put,patch,delete]
    then:
      field: x-microcks-operation
      function: truthy
  servers-expected-domain:
    description: Server URLs should be on the sharepoint.com domain.
    severity: warn
    given: $.servers[*].url
    then:
      function: pattern
      functionOptions:
        match: sharepoint\.com
  schema-names-casing:
    description: Component schema names should be PascalCase (the dominant convention in this API).
    severity: warn
    given: $.components.schemas
    then:
      field: '@key'
      function: casing
      functionOptions:
        type: pascal
  error-schema-defined:
    description: A shared error schema (Error) should be defined for error payloads.
    severity: warn
    given: $.components.schemas
    then:
      field: Error
      function: truthy

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/microsoft-project-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.

GitHub Google LinkedIn

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