API Documentation Audit
This report lists missing documentation per operation. It describes the documentation's structure, not the API's domain meaning, per the profile linked above.
Summary
- Resources: 19
- Operations: 28
- Operations with response schema: 11
- Operations with request schema: 12
- Operations with ALPS attributes: 6
Findings
GET /address
alpsMissing ALPS attribute.
GET /alps-fallback
response-schemaMissing response schema.alpsMissing ALPS attribute.
GET /array-data
class-summaryMissing resource class summary.alpsMissing ALPS attribute.
GET /calendar/{year}/{month}
class-summaryMissing resource class summary.alpsMissing ALPS attribute.
GET /card
class-summaryMissing resource class summary.alpsMissing ALPS attribute.
POST /contact
response-schemaMissing response schema.request-schemaMissing request schema for non-path body input.class-summaryMissing resource class summary.operation-summaryMissing operation summary.alpsMissing ALPS attribute.
POST /contact-with-descriptions
response-schemaMissing response schema.class-summaryMissing resource class summary.operation-summaryMissing operation summary.alpsMissing ALPS attribute.
POST /docblock-variants
response-schemaMissing response schema.request-schemaMissing request schema for non-path body input.class-summaryMissing resource class summary.operation-summaryMissing operation summary.alpsMissing ALPS attribute.
GET /index
response-schemaMissing response schema.class-summaryMissing resource class summary.alpsMissing ALPS attribute.
POST /input-edge-cases
response-schemaMissing response schema.request-schemaMissing request schema for non-path body input.class-summaryMissing resource class summary.operation-summaryMissing operation summary.alpsMissing ALPS attribute.
PUT /input-edge-cases
response-schemaMissing response schema.request-schemaMissing request schema for non-path body input.class-summaryMissing resource class summary.operation-summaryMissing operation summary.alpsMissing ALPS attribute.
GET /missing-schema
alpsMissing ALPS attribute.
GET /numbers
class-summaryMissing resource class summary.alpsMissing ALPS attribute.
GET /org
class-summaryMissing resource class summary.alpsMissing ALPS attribute.
PATCH /person
response-schemaMissing response schema.alpsMissing ALPS attribute.
POST /person
response-schemaMissing response schema.
PUT /ticket/assign
response-schemaMissing response schema.request-schemaMissing request schema for non-path body input.alpsMissing ALPS attribute.
DELETE /ticket/{id}
response-schemaMissing response schema.alpsMissing ALPS attribute.
GET /ticket/{id}
alpsMissing ALPS attribute.
POST /ticket/{id}
response-schemaMissing response schema.alpsMissing ALPS attribute.
PUT /ticket/{id}
response-schemaMissing response schema.alpsMissing ALPS attribute.
GET /tickets
class-summaryMissing resource class summary.operation-summaryMissing operation summary.alpsMissing ALPS attribute.
GET /union-type
response-schemaMissing response schema.class-summaryMissing resource class summary.alpsMissing ALPS attribute.
DELETE /users/{id}
response-schemaMissing response schema.
POST /users/{id}
response-schemaMissing response schema.
PUT /users/{id}
response-schemaMissing response schema.