For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Akamai.com Linode.com Contact us Try Akamai

Guide Recipes API

Skip to navigation

Parameters Params

Param missing description

GET

http://{hostname}/test-suite/v2/param-desc-missing/:parameterId

GET

/test-suite/v2/param-desc-missing/:parameterId

curl http://{hostname}/test-suite/v2/param-desc-missing/parameterId

204No Content

{}

Throw error for missing description.

Path parameters

parameterIdstringRequired

Response

Empty response.

Was this page helpful?

Missing `allowEmptyValue` syntax

Guide Recipes API

Beta Swagger Spec
Data
Deprecated Swagger Spec
Exclude Components And Custom Syntax
Internal OpenAPI 3.1 Support
Language
Limited Availability Swagger Base Path
Operation
Parameters
Sample Data
Service
Service SVC
The Response API

Base URL not kosher
Redundant URL path
Test arrays
Test booleans
Test custom data schemas and read/write labels
The body camelcase words
First word lowercase
Test null
Test numeric data
Test objects
Test allOf polymorphism
Test dynamic generation of sample JSON from blended allOf schema
Test anyOf polymorphism
Test oneOf polymorphism
Test request members
Test response members
Basic schema tests
Check dummy schemas
Test schema members names
Test strings
openapi-enforcer errors
OpenAPI file should not spec components
Redundant externalDocs object
Malformed static path segments
OpenAPI file includes $refs to schema subparts
Linked paths
Version should be nN string
Unresponsive URL segment
Endpoint path has trailing slash
Final segment is CRUD verb
Mark custom products
Mark operation status
Custom parameter status
Warn about non-standard folder
Retain this operation
Retain this path-linked operation
Exclude parameters, schemas
Exclude data schemas
Schema tests on OpenAPI 3.1
Description is unpunctuated
Overly long embedded literal
Regex pattern tests
Test for long paragraph
Test for more than one paragraph
openapi-enforcer errors
Swagger base path tests
Wrong error Content-Type
A DELETE operation with a 204 response without a body and error responses
Deprecated operation no EOL
A PUT operation without a corresponding GET
OperationId maximum
A PUT operation with empty request and response
429 response present, no rate limiting headers in 2xx
Multi mime type
Multi mime type versioned
A PUT operation with data not required
A PATCH operation with no data
A PUT operation specifies no data
Examples and schemas for binary content-types
Examples and schemas for binary content-types
Summary and description in path
Deprecated syntax present with faulty description
Deprecated syntax missing
Operation links to itself
An operation lacks description
Operation with description in request body
Deleting an operation
GET descriptor on a collection
Plural descriptors on a GET. List an object
An Operation in Capitalized Title Case
An operation title is mistakenly punctuated.
A PUT Operation Title missing put_descriptors
Operation lacks DEPRECATED status
Operation lacks DEPRECATED boolean
Operation with no status
Operation with DEPRECATED status
Operation with LA status
Operation with BETA status
Operation with invalid status value
Missing example
Invalid examples
Examples with overly long summaries
Too many examples
Only one examples
Examples with non sentence case summaries
RAML operationId
Malformed operationId
Operation ID needs a leading method
Problem object should be extendable
Missing 429 response when rate limiting headers in a success response
No schema for an example in the request body
Redundant operation title
Redundant operation title
GET op sorts 2nd
POST op sorts 1st
PUT op sorts 3rd
DELETE op sorts 4th
GET op whose schema mismatches PUT
PUT op whose schema mismatches GET
GET op whose schema mismatches inline PUT
PUT op whose inline schema mismatches GET
Suppress method's account switch query param
Multiple tags
Punctuated tags
Get an object
openapi-enforcer errors
Unreferenced sample in body or response
Warn about mime types that need string examples
Query param is defined at path level
Path param is defined at method level
Missing enum value in description (2DO)
Param description unpunctuated
Accept or Content-Type header present
Param description has HTML comment
Parameter specifies an array schema
Optional boolean parameter's `example` matches `default`
Missing `default` in description
Missing `default` syntax
Missing `default` syntax
Missing `default` syntax
Missing style description
Missing style syntax
Param missing description
Missing `allowEmptyValue` syntax
Missing empty in description
Unencoded param characters
Missing param example
Action param name
Param name not camelCase
Param name repeated in description
Unqualified path param
Missing nullable syntax
Missing null in description
Parameter specifies an object schema
Param required with default
Incorrect param example
openapi-enforcer errors
Header name malformed
openapi-enforcer errors
Test sample data
Long sample data file
JSON payload is not array or object
Multi-line description
Example link is malformed
Op description contains HTML comment
Inline examples in the examples object
Redundant URL path
Redundant swagger title
A 200 response without any data specified
201 response has no data provided
201 response has no data provided
A 429 is present, but 2xx missing rate limiting headers
An error response application/json type
An operation with an ETag header
A DELETE operation with data specified
A GET operation with no response data
A PATCH operation with no response data
A POST operation with no response data
A POST operation with no Location header
A PUT operation with no response data
A GET operation after a DELETE
An operation with multi type formats
An operation with multi type versions
Operation's schema linked inline
openapi-enforcer errors

Home
EdgeWorkers
Demo APIs
Sample Spec