Last updated

Comparison of api's results

Lint

We have applied following rules:

  spec: error
  info-license: error
  no-ambiguous-paths: error
  no-http-verbs-in-paths:
    severity: error
    splitIntoWords: true
  rule/operationId-casing:
    subject:
      type: Operation
      property: operationId
    assertions:
      casing: camelCase
  rule/no-description-start-with-the-a-an:
    subject:
      type: any
      property: description
    assertions:
      notPattern: /^(The\s|A\s|An\s)/

Only Museum API passed it. Other API's failed, unfortunately, we didn't see in build errors any messages which rules failed (we've already noted it).

Scorecard

We have enabled scorecard feature, but after some modifications, we have broken it and we failed to re-enable it. Currently our API's card look as following: no-scorecard.png. Previously we had scorecard results visible on them.

Stats

We were asked to run stats cli command, but since we have decided not to use remote content, we didn't know how to run it as we don't have straightforward way of cloning repository to our machine and running redocly cli against it.