Zally · JSON Structure

Zally Api Linting Request Structure

Request containing a swagger definition file. One of the following fields must be provided: api_definition, api_definition_string, or api_definition_url.

Type: object Properties: 4
API DesignAPI LintingAPI QualityOpen SourceOpenAPIZalando

LintingRequest is a JSON Structure definition published by Zally, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

api_definition api_definition_string api_definition_url ignore_rules

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zally/refs/heads/main/json-structure/zally-api-linting-request-structure.json",
  "name": "LintingRequest",
  "description": "Request containing a swagger definition file. One of the following fields must be provided:\napi_definition, api_definition_string, or api_definition_url.\n",
  "type": "object",
  "properties": {
    "api_definition": {
      "type": "object",
      "description": "Specification object in OpenAPI format",
      "example": {}
    },
    "api_definition_string": {
      "type": "string",
      "description": "Raw API Specification string in OpenAPI format",
      "example": "example-value"
    },
    "api_definition_url": {
      "type": "string",
      "description": "Link to the specification in OpenAPI format",
      "example": "https://example.com/path/abc123"
    },
    "ignore_rules": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of rule ids to be ignored",
      "example": [
        "example-value"
      ]
    }
  }
}