Skip to navigation
DataStrings

Test strings

This tests strings.

Query parameters

accountSwitchKeystringOptional

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Request

This endpoint expects an object.
patternsobjectOptional

Test what kind of string-quoting you may need for the \. in this long regex: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

spec-enforcer-parse-err-false-positiveenumOptional

This demonstrates the openapi-enforcer validate command yielding a false-positive parsing error when it encounters a $ref link to an array, in this case an enum. Supported values are GROUCHO, CHICO, HARPO, and ZEPPO.

Allowed values:
str-date-fmt-missingstringOptional

TBD timestamp string lacks format.

str-date-offsetstringOptional
TBD warn against time zone offset values in samples.
str-enum-alphenumOptional

Enum values are spec'ed in weird order (GEORGE, JOHN, PAUL, RINGO), affecting popup menu.

Allowed values:
str-enum-desc-alphenumOptional

These enums are described in bad order: GEORGE, JOHN, PAUL, RINGO.

Allowed values:
str-enum-desc-lengthenumOptional

Provides a reason for an Image and Video Manager failure. The possible values are: DURATION when the pristine video exceeds the maximum duration of 5 minutes, BYTES when the pristine video exceeds the maximum size of 256 MB, PIXEL when the pristine video pixels exceed 3,686,400 (1920×1920), SAMPLERATE when the pristine video exceeds maximum sample rate of 60 Hz, UNPARSEABLE when the pristine video is not a recognized or supported video format, PRISTINE_TOO_WIDE when the pristine image width exceeds 9999 pixels, PRISTINE_TOO_TALL when the pristine image height exceeds 9999 pixels, PROCESS_FAILED_INTERNALLY when the image or video could not be fetched from the origin or the policy is outdated, or INVALID_POLICY when the policy parameters are invalid.

str-enum-desc-maxenumOptional

Ten or more enum values in a description. A, B, C, D, E, F, G, H, I, J.

str-enum-desc-unlistedobjectOptional
str-enum-desc-unorderedenumOptional

Throw a str-enum-desc-unordered warning because these HUEY, DEWEY, and LOUIE values aren't sequenced the same as the schema's enum spec.

Allowed values:
str-enum-desc-unspecedenumOptional

This description details each enum value. Values are GROUCHO, CHICO, HARPO, and ZEPPO. But flag random other LITERAL values that may be in the description, but not spec'ed in the enumeration.

Allowed values:
str-enum-desc-unspeced-emptyenumOptional

Test a special case where the enum specs an empty string. Either GROUCHO, CHICO, HARPO, or an empty string ("").

Allowed values:
str-enum-detailsenumOptional

This schema tests whether we can use HTML's <details> and <summary> tags to embed collapsible sections of overly long descriptions, such as lists of enum values. This also tests whether un-described values still get flagged as blocking error. This block of text always displays as the main description. The status of the certificate deployment on the production network.

This text renders as a prompt. Details on possible values...

<ul> <li>DEPLOYING indicates the deployment is in progress. See HTML cross reference, whose ref: slug should link to the API summary topic. <li>PENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded. <li>NEEDS_ACTIVATION indicates the validation is complete and you need to activate the property version to deploy the certificate to the staging network. <li>DEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic. <li>STALLED indicates a problem with validation or deployment of your certificate. To try again, create and activate a new property version, or contact Akamai Professional Services for help. <li>PROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. <li>CAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. <li>EXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again. <li>UNKNOWN_FAILURE. <ul>

str-enum-differentiator-missingobjectOptional
Missing a differentiator.
str-enum-emptyenumOptional

Enum includes an empty string other than GROUCHO and CHICO, bad API design.

Allowed values:
str-enum-integerenumOptional

Enum is a set of integer values: 404, 400, and 500.

Allowed values:
str-enum-integer-rangestringOptional
TBD unbroken numeric enum range best expressed as minimum and maximum range.
str-enum-keyword-anyofstring or enumOptional

There's no test to log this edge case, but this checks how well Readme represents a mixed set of flexible/fixed string values as an anyOf vs. a oneOf. The latter may fail if each logical alternative overlaps.

str-enum-keyword-oneofstring or enumOptional

There's no test to log this edge case, but this checks how well Readme represents a mixed set of flexible/fixed string values as an anyOf vs. a oneOf. The latter may fail if each logical alternative overlaps.

str-enum-nullableenum or nullOptional

This enum is nullable, bad API design. Values: GROUCHO, CHICO, HARPO.

Allowed values:
str-enum-orphanenumOptional

Single supported enum value: ALL_ALONE. Will this enum set grow?

Allowed values:
str-enum-repeatedenumOptional

Enum specs the same value redundantly, HARPO and the repeated CHICO.

Allowed values:
str-enum-repeated-caseenumOptional

Along with correctly formatted TWO_WORDS, enum specs case- and punc-insensitive variants, unlikely: two-words, Two Words, twoWords.

Allowed values:
str-enum-string-integerenumOptional

Enum values have stringified numbers: 400, 404, and 500.

Allowed values:
str-enum-type-conflictobjectOptional
Data type for enum set doesn't match schema type.
str-enum-type-mixedenumOptional

Enum set includes a mix of data types: 400 integer and 401 string.

Allowed values:
str-enum-type-weirdobjectOptional
Data type for enum set is boolean or null.
str-enum-unspeced-descstringOptional

This is an enum with no spec. The possible values are: 1, 2, 3.

str-enum-unspeced-nameobjectOptional
These should all likely be enums based on their names.
str-enum-values-malformedenumOptional

Enum values that don't follow UPPERCASE_UNDERSCORE format.

str-fmt-bytestringOptional

A schema for a Base64 string should spec format: byte.

str-fmt-emailobjectOptional

The schema should spec format: email.

str-fmt-hostnameobjectOptional

Schema should spec format: hostname.

str-fmt-ipobjectOptional

Based on name, schema should specify format: ipv6 or ipv4.

str-fmt-timestampobjectOptional

Based on their names, schema should spec format: date-time or date.

str-fmt-uriobjectOptional

Schemas should spec'ed as format: uri.

str-min-conflict-formatdatetimeOptional

String schema specifies both minLength and format.

str-min-missingstringOptional

Beta, Bot Manager String schema lacks any minLength.

threshold-maxstringOptional<=32 characters
Sample string data is too long.
threshold-minstringOptional>=1 character

Sample string data is zero-length, too short.

Response

Successful response.
patternsobjectOptional

Test what kind of string-quoting you may need for the \. in this long regex: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

spec-enforcer-parse-err-false-positiveenumOptional

This demonstrates the openapi-enforcer validate command yielding a false-positive parsing error when it encounters a $ref link to an array, in this case an enum. Supported values are GROUCHO, CHICO, HARPO, and ZEPPO.

Allowed values:
str-date-fmt-missingstringOptional

TBD timestamp string lacks format.

str-date-offsetstringOptional
TBD warn against time zone offset values in samples.
str-enum-alphenumOptional

Enum values are spec'ed in weird order (GEORGE, JOHN, PAUL, RINGO), affecting popup menu.

Allowed values:
str-enum-desc-alphenumOptional

These enums are described in bad order: GEORGE, JOHN, PAUL, RINGO.

Allowed values:
str-enum-desc-lengthenumOptional

Provides a reason for an Image and Video Manager failure. The possible values are: DURATION when the pristine video exceeds the maximum duration of 5 minutes, BYTES when the pristine video exceeds the maximum size of 256 MB, PIXEL when the pristine video pixels exceed 3,686,400 (1920×1920), SAMPLERATE when the pristine video exceeds maximum sample rate of 60 Hz, UNPARSEABLE when the pristine video is not a recognized or supported video format, PRISTINE_TOO_WIDE when the pristine image width exceeds 9999 pixels, PRISTINE_TOO_TALL when the pristine image height exceeds 9999 pixels, PROCESS_FAILED_INTERNALLY when the image or video could not be fetched from the origin or the policy is outdated, or INVALID_POLICY when the policy parameters are invalid.

str-enum-desc-maxenumOptional

Ten or more enum values in a description. A, B, C, D, E, F, G, H, I, J.

str-enum-desc-unlistedobjectOptional
str-enum-desc-unorderedenumOptional

Throw a str-enum-desc-unordered warning because these HUEY, DEWEY, and LOUIE values aren't sequenced the same as the schema's enum spec.

Allowed values:
str-enum-desc-unspecedenumOptional

This description details each enum value. Values are GROUCHO, CHICO, HARPO, and ZEPPO. But flag random other LITERAL values that may be in the description, but not spec'ed in the enumeration.

Allowed values:
str-enum-desc-unspeced-emptyenumOptional

Test a special case where the enum specs an empty string. Either GROUCHO, CHICO, HARPO, or an empty string ("").

Allowed values:
str-enum-detailsenumOptional

This schema tests whether we can use HTML's <details> and <summary> tags to embed collapsible sections of overly long descriptions, such as lists of enum values. This also tests whether un-described values still get flagged as blocking error. This block of text always displays as the main description. The status of the certificate deployment on the production network.

This text renders as a prompt. Details on possible values...

<ul> <li>DEPLOYING indicates the deployment is in progress. See HTML cross reference, whose ref: slug should link to the API summary topic. <li>PENDING indicates you need to add the validation challenge to your DNS and activate the property version on staging or production to deploy your certificate to that network. If you've done that already, run the operation again later to check if the deployment succeeded. <li>NEEDS_ACTIVATION indicates the validation is complete and you need to activate the property version to deploy the certificate to the staging network. <li>DEPLOYED indicates the certificate is successfully validated on the network and ready to handle secure traffic. <li>STALLED indicates a problem with validation or deployment of your certificate. To try again, create and activate a new property version, or contact Akamai Professional Services for help. <li>PROHIBITED_DOMAIN_FAILURE indicates the hostname isn't in the Let's Encrypt Certificate Authority domain allow list. <li>CAA_MISMATCH_RETRYING or CAA_MISMATCH_FAILURE indicate you need to configure your Certification Authority Authorization (CAA) policy to allow Let's Encrypt. <li>EXPIRING_SOON_NEEDS_VALIDATION indicates your certificate is due to expire or already expired, and you need to add the _acme-challenge validation CNAME record in your DNS again. <li>UNKNOWN_FAILURE. <ul>

str-enum-differentiator-missingobjectOptional
Missing a differentiator.
str-enum-emptyenumOptional

Enum includes an empty string other than GROUCHO and CHICO, bad API design.

Allowed values:
str-enum-integerenumOptional

Enum is a set of integer values: 404, 400, and 500.

Allowed values:
str-enum-integer-rangestringOptional
TBD unbroken numeric enum range best expressed as minimum and maximum range.
str-enum-keyword-anyofstring or enumOptional

There's no test to log this edge case, but this checks how well Readme represents a mixed set of flexible/fixed string values as an anyOf vs. a oneOf. The latter may fail if each logical alternative overlaps.

str-enum-keyword-oneofstring or enumOptional

There's no test to log this edge case, but this checks how well Readme represents a mixed set of flexible/fixed string values as an anyOf vs. a oneOf. The latter may fail if each logical alternative overlaps.

str-enum-nullableenum or nullOptional

This enum is nullable, bad API design. Values: GROUCHO, CHICO, HARPO.

Allowed values:
str-enum-orphanenumOptional

Single supported enum value: ALL_ALONE. Will this enum set grow?

Allowed values:
str-enum-repeatedenumOptional

Enum specs the same value redundantly, HARPO and the repeated CHICO.

Allowed values:
str-enum-repeated-caseenumOptional

Along with correctly formatted TWO_WORDS, enum specs case- and punc-insensitive variants, unlikely: two-words, Two Words, twoWords.

Allowed values:
str-enum-string-integerenumOptional

Enum values have stringified numbers: 400, 404, and 500.

Allowed values:
str-enum-type-conflictobjectOptional
Data type for enum set doesn't match schema type.
str-enum-type-mixedenumOptional

Enum set includes a mix of data types: 400 integer and 401 string.

Allowed values:
str-enum-type-weirdobjectOptional
Data type for enum set is boolean or null.
str-enum-unspeced-descstringOptional

This is an enum with no spec. The possible values are: 1, 2, 3.

str-enum-unspeced-nameobjectOptional
These should all likely be enums based on their names.
str-enum-values-malformedenumOptional

Enum values that don't follow UPPERCASE_UNDERSCORE format.

str-fmt-bytestringOptional

A schema for a Base64 string should spec format: byte.

str-fmt-emailobjectOptional

The schema should spec format: email.

str-fmt-hostnameobjectOptional

Schema should spec format: hostname.

str-fmt-ipobjectOptional

Based on name, schema should specify format: ipv6 or ipv4.

str-fmt-timestampobjectOptional

Based on their names, schema should spec format: date-time or date.

str-fmt-uriobjectOptional

Schemas should spec'ed as format: uri.

str-min-conflict-formatdatetimeOptional

String schema specifies both minLength and format.

str-min-missingstringOptional

Beta, Bot Manager String schema lacks any minLength.

threshold-maxstringOptional<=32 characters
Sample string data is too long.
threshold-minstringOptional>=1 character

Sample string data is zero-length, too short.