Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zally Api Violations API

The Api Violations API from Zally — 2 operation(s) for api violations.

Zally Api Violations API is one of 3 APIs that Zally publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Api Violations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a JSON-LD context, and 2 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 2.3.0.

Requests are made against a single base URL, https://zally.on.inter.net.

2 operations 2 paths 5 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.3.0
Base URL
https://zally.on.inter.net
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Zally Api Violations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Api Violations 2
POST
/api-violations
Zally API Violations
body → 200400default
GET
/api-violations/{externalId}
Zally Get Previous Generated Validation Result
1 param → 200404default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Violation (8 properties), ViolationsCount (5 properties), LintingRequest (4 properties), LintingResponse (4 properties). Each schema is shown below with its type and property counts.

RuleType
string
Rule type / severity
LintingResponse
object
Linting Response
4 properties 2 required
Violation
object
Violation Object
8 properties 4 required
LintingRequest
object
Request containing a swagger definition file. One of the following fields must be provided: apidefinition, apidefinitionstring, or apidefinitionurl.
4 properties
ViolationsCount
object
Violation Count
5 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zally-api-violations-api-openapi.yml Raw ↑

Other APIs Zally publishes across the network.

Zally Review Statistics API
Zally Supported Rules API