Schema Include Postman Public Workspace

schema-include-postman-public-workspace

Has Public Postman Workspace

Rule definition

The full Spotlight rule — drop it into a ruleset (.spotlight.yaml / .spectral.yaml) and run it with any Spotlight tool.

schema-include-postman-public-workspace:
  title: Schema Include Postman Public Workspace
  reference: https://spotlight-rules.com/spec/rules/apis-json/schema-include-postman-public-workspace/
  description: This property ensures that an API is associated with a Postman
    Workspace, providing a single location that API producers and/or API
    consumers can engage around an API.
  message: Has Public Postman Workspace
  severity: info
  given:
    - $.apis.*.properties.*
    - $.common.*
  then:
    - field: type
      function: pattern
      functionOptions:
        notMatch: \b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\b
  tags:
    - format:apis-json
    - spec:apis
    - spec:properties
    - experience:usability
    - experience:discoverability
  prompt: "You are editing an APIs.json document to satisfy the Spotlight API
    governance rule 'schema-include-postman-public-workspace' (Schema Include
    Postman Public Workspace). Requirement: This property ensures that an API is
    associated with a Postman Workspace, providing a single location that API
    producers and/or API consumers can engage around an API. To fix: Ensure
    `type` does NOT match the regular expression
    `\\b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\\b`;
    rename or rewrite any value that does. This rule is evaluated at the
    JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it
    matches and correct only what violates the rule. Make the smallest change
    that satisfies the rule, leave all unrelated content, key order, comments,
    and formatting unchanged, and keep the document valid APIs.json. Return only
    the complete corrected document, with no commentary."

You are editing an APIs.json document to satisfy the Spotlight API governance rule 'schema-include-postman-public-workspace' (Schema Include Postman Public Workspace). Requirement: This property ensures that an API is associated with a Postman Workspace, providing a single location that API producers and/or API consumers can engage around an API. To fix: Ensure `type` does NOT match the regular expression `\b(postman-public-workspace|PostmanPublicWorkspace|PostmanWorkspace)\b`; rename or rewrite any value that does. This rule is evaluated at the JSONPath `$.apis.*.properties.* | $.common.*` — inspect every location it matches and correct only what violates the rule. Make the smallest change that satisfies the rule, leave all unrelated content, key order, comments, and formatting unchanged, and keep the document valid APIs.json. Return only the complete corrected document, with no commentary.