Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.21 KB

File metadata and controls

18 lines (14 loc) · 1.21 KB

Maintainability Benchmark of OpenAPI Specifications

This repo contains a maintainability benchmark of publicly available OpenAPI specs based on expert ratings. You will find three things in here:

Suggested Study Process

  1. Carefully read the rating guide, then download and examine the rating scheme.
  2. While keeping the schema in mind, analyze each API.
    • Read the description of the API.
    • Navigate to the OpenAPI file and analyze its contents. You can also download the repo to your machine to ease browsing.
    • Create a preliminary rating for the API based on your analysis. Provide comments for your rationale, if appropriate.
  3. After analyzing all APIs, refine the preliminary ratings based on your newly-gained insights.
  4. Fill in the demographic data in the second tab of the rating scheme.
  5. Send the filled out rating scheme back to us via email.