Basic schema tests | Akamai TechDocs

curl -X PUT http://{hostname}/test-suite/v2/data/schema \
     -H "Content-Type: application/json" \
     -d '{
  "schema-desc-links-self": "All work and no play makes Jack a dull boy.",
  "schema-desc-malformed-para": "All work and no play makes Jack a dull boy.",
  "schema-desc-missing": "All work and no play makes Jack a dull boy.",
  "schema-get-put-mismatch": "All work and no play makes Jack a dull boy.",
  "schema-invalid-against-sample": {
    "bar": true,
    "foo": true
  },
  "schema-name-malformed": "All work and no play makes Jack a dull boy.",
  "schema-name-misspelled": {
    "certficateName": "All work and no play makes Jack a dull boy.",
    "operationid": "All work and no play makes Jack a dull boy."
  },
  "schema-orphaned": "All work and no play makes Jack a dull boy.",
  "schema-poly-anonymous": "All work and no play makes Jack a dull boy.",
  "schema-redundant": "All work and no play makes Jack a dull boy.",
  "schema-redundant-membership": "All work and no play makes Jack a dull boy.",
  "schema-type-missing": null
}'

{
  "schema-desc-links-self": "All work and no play makes Jack a dull boy.",
  "schema-desc-malformed-para": "All work and no play makes Jack a dull boy.",
  "schema-desc-missing": "All work and no play makes Jack a dull boy.",
  "schema-get-put-mismatch": "All work and no play makes Jack a dull boy.",
  "schema-invalid-against-sample": {
    "bar": true,
    "foo": true
  },
  "schema-name-malformed": "All work and no play makes Jack a dull boy.",
  "schema-name-misspelled": {
    "certficateName": "All work and no play makes Jack a dull boy.",
    "operationid": "All work and no play makes Jack a dull boy."
  },
  "schema-orphaned": "All work and no play makes Jack a dull boy.",
  "schema-poly-anonymous": "All work and no play makes Jack a dull boy.",
  "schema-redundant": "All work and no play makes Jack a dull boy.",
  "schema-redundant-membership": "All work and no play makes Jack a dull boy.",
  "schema-type-missing": null
}

This tests basic schemas.

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.

badly formatted keybooleanOptional

Should trigger the schema-name-malformed test for a bad key name.

enumValueenumOptional

Unclear what this tests: Value1.

Allowed values:

falsestringOptional

A boolean name that needs quotes. Should trigger a schema-name-boolean warning.

lang-desc-link-invalidstringOptional

Here we have a malformed doc slug prefix and some (completely inverted link syntax)[ref:inverted-syntax].

lang-desc-numbered-slugstringOptional

This description provides a link with a -1 slug DOC and other doc numbered slug.

openapi-html-commentbooleanOptional

openapi-schema-ref-allofbooleanOptional

openapi-schema-ref-conflictbooleanOptionalDefaults to false

This schema is $ref linked.

openapi-schema-ref-conflict-allofbooleanOptionalDefaults to false

openapi-schema-ref-overloadobjectOptional

Test different ways to arrange descriptions along with $ref links.

random-yamlenumOptional

This schema placed in an arbitrary YAML wrapper is $ref-linked with 'randomly-arranged.yaml#/yuccaPudooType' from another schema.

Allowed values:

schema-desc-links-selfstringOptional

This schema-level link is self-referential.

schema-desc-malformed-parastringOptional

TBD description has punctuation and is a full sentence.

schema-desc-missingstringOptional

schema-example-redundantstringOptional

This schema should not embed an example that's redundant with separate sample data.

schema-get-put-mismatchstringOptional

TBD GET rsp & PUT req should link same schema.

schema-invalid-against-sampleobjectOptional

Simple membership test to check if the CLI validates sample data against the schema.

schema-name-case-sensitiveobjectOptional

Complain about all these schema names varying in case.

schema-name-malformedstringOptional

Complain about this schema name not being camelCase.

schema-name-misspelledobjectOptional

There are typos in nested camelCase member names. There is Content-Type. Adn There is and Content-Type. and ContentType:

schema-name-parrotedstringOptional

Complain about the schema-name-parroted name appearing again in the description.

schema-operation-links-selfstringOptional

This schema-level link is self-referential.

schema-orphanedstringOptional

TBD schema file is an unreferenced orphan.

schema-poly-anonymousstringOptional

TBD oneOf/anyOf: each scenario needs a label.

schema-redundantstringOptional

TBD redundant schema, normalized for description.

schema-redundant-membershipstringOptional

TBD schema is redundant, same set of members.

schema-type-missinganyOptional

This schema lacks a type.

svc-tally-named-obj-keysobjectOptional

Test variance among same-named object schemas' set of defined members.

svc-tally-obj-keysobjectOptional

Complain that this set of keys is defined in more than one schema file.

svc-tally-schema-descobjectOptional

Test variance among schema descriptions.

svc-tally-schema-enum-valuesobjectOptional

Test variance among schemas' enum values. Also check for when an enum is both defined and undefined for the same data member. The test needs to account for irrelevant variance in enum sort order.

svc-tally-schema-typeobjectOptional

Test variance among schema types.

Response

Successful response.

badly formatted keybooleanOptional

Should trigger the schema-name-malformed test for a bad key name.

enumValueenumOptional

Unclear what this tests: Value1.

Allowed values:

falsestringOptional

A boolean name that needs quotes. Should trigger a schema-name-boolean warning.

lang-desc-link-invalidstringOptional

Here we have a malformed doc slug prefix and some (completely inverted link syntax)[ref:inverted-syntax].

lang-desc-numbered-slugstringOptional

This description provides a link with a -1 slug DOC and other doc numbered slug.

openapi-html-commentbooleanOptional

openapi-schema-ref-allofbooleanOptional

openapi-schema-ref-conflictbooleanOptionalDefaults to false

This schema is $ref linked.

openapi-schema-ref-conflict-allofbooleanOptionalDefaults to false

openapi-schema-ref-overloadobjectOptional

Test different ways to arrange descriptions along with $ref links.

random-yamlenumOptional

This schema placed in an arbitrary YAML wrapper is $ref-linked with 'randomly-arranged.yaml#/yuccaPudooType' from another schema.

Allowed values:

ref-overloadstringOptionalRead-only1-1024 characters

Read-only Test to confirm that because this description is present, lack of a description in the target $ref schema is not flagged as an error. Also check if additional schema logic is defined outside the $ref, you should get an error.

schema-desc-links-selfstringOptional

This schema-level link is self-referential.

schema-desc-malformed-parastringOptional

TBD description has punctuation and is a full sentence.

schema-desc-missingstringOptional

schema-example-redundantstringOptional

This schema should not embed an example that's redundant with separate sample data.

schema-get-put-mismatchstringOptional

TBD GET rsp & PUT req should link same schema.

schema-invalid-against-sampleobjectOptional

Simple membership test to check if the CLI validates sample data against the schema.

schema-name-case-sensitiveobjectOptional

Complain about all these schema names varying in case.

schema-name-malformedstringOptional

Complain about this schema name not being camelCase.

schema-name-misspelledobjectOptional

There are typos in nested camelCase member names. There is Content-Type. Adn There is and Content-Type. and ContentType:

schema-name-parrotedstringOptional

Complain about the schema-name-parroted name appearing again in the description.

schema-operation-links-selfstringOptional

This schema-level link is self-referential.

schema-orphanedstringOptional

TBD schema file is an unreferenced orphan.

schema-poly-anonymousstringOptional

TBD oneOf/anyOf: each scenario needs a label.

schema-redundantstringOptional

TBD redundant schema, normalized for description.

schema-redundant-membershipstringOptional

TBD schema is redundant, same set of members.

schema-type-missinganyOptional

This schema lacks a type.

svc-tally-named-obj-keysobjectOptional

Test variance among same-named object schemas' set of defined members.

svc-tally-obj-keysobjectOptional

Complain that this set of keys is defined in more than one schema file.

svc-tally-schema-descobjectOptional

Test variance among schema descriptions.

svc-tally-schema-enum-valuesobjectOptional

Test variance among schemas' enum values. Also check for when an enum is both defined and undefined for the same data member. The test needs to account for irrelevant variance in enum sort order.

svc-tally-schema-typeobjectOptional

Test variance among schema types.