APIs.json Name (Negative) (Edit)

The name of an APIs.json file is different than the name of your API, and is intended to describe the purpose of the APIs.json artifact, and what it provides for API producers, consumers, and other stakeholders. The name should be short and concise, describing the intent in bringing the the collection together, leaving the names of APIs to describe what each API does. You can find details about the names property for APIs.json, and explore APIs.json names more via API Evangelist.

JSON Version

{"description":"The name of an APIs.json file is different than the name of your API, and is intended to describe the purpose of the APIs.json artifact, and what it provides for API producers, consumers, and other stakeholders. The name should be short and concise, describing the intent in bringing the the collection together, leaving the names of APIs to describe what each API does. You can find details about the <a href=\"https://apisjson.org/schema/names/\">names property for APIs.json</a>, and explore <a href=\"https://apievangelist.com/guidance/naming/apis-json-names/\" target=\"_blank\">APIs.json names</a> more via API Evangelist.","message":"There MUST be a name.","severity":"error","given":"$","then":{"field":"name","function":"truthy"}}

YAML Version

Back to All of the Rules