Lint OpenAPI
POST {{baseUrl}}/linter?rulesUrl=https://kinlane-productions2.s3.amazonaws.com/spectral/adidas-api-guidelines.spectral.yaml
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
rulesUrl | string | A dynamic ruleset built from multiple description rules. You can pass in any rules or ruleset of your own. |
RESPONSES
status: OK
[{"code":"openapi-v3-info-title","status":"passed","message":"Ensures that all OpenAPIs have a information object title."},{"code":"openapi-v3-info-title-max-length","status":"passed","message":"Ensures that all OpenAPIs information titles are not longer than 50 characters."},{"code":"openapi-v3-info-title-word-check","status":"passed","message":"Ensures that all OpenAPIs info object title do not contain certain words."},{"code":"openapi-v3-info-title-in-kebab-case","status":"failed","message":"Ensures that all OpenAPIs information title are in Kebab case.","failure":{"message":"The info object title needs to be in Kebab case.","path":["info","title"],"severity":0,"source":"\u003cREQUEST_BODY_0\u003e","range":{"start":{"line":0,"character":54},"end":{"line":0,"character":67}}}},{"code":"openapi-v3-info-summary","status":"failed","message":"Ensures that all OpenAPIs have a information object summary.","failure":{"message":"The info object should have a summary.","path":["info"],"severity":0,"source":"\u003cREQUEST_BODY_0\u003e","range":{"start":{"line":0,"character":26},"end":{"line":0,"character":139}}}},{"code":"openapi-v3-info-summary-max-length","status":"passed","message":"Ensures that all OpenAPIs information object summary are not too long."},{"code":"openapi-v3-info-summary-word-check","status":"passed","message":"Ensures that all OpenAPIs information object summary do not contain some words."},{"code":"openapi-v3-info-description","status":"passed","message":"Ensures that all OpenAPIs have a information description."},{"code":"openapi-v3-info-description-max-length","status":"passed","message":"Ensures that all APIs descriptions are under a specific length."},{"code":"openapi-v3-info-description-word-check","status":"passed","message":"Ensures that all APIs descriptions do not contain certain words."},{"code":"openapi-v3-info-contact","status":"failed","message":"Ensures that all APIs have contact information.","failure":{"message":"API must have a contact information available.","path":["info"],"severity":0,"source":"\u003cREQUEST_BODY_0\u003e","range":{"start":{"line":0,"character":26},"end":{"line":0,"character":139}}}},{"code":"openapi-v3-info-contact-name","status":"passed","message":"Ensures that all APIs have contact name."},{"code":"openapi-v3-info-contact-email","status":"passed","message":"Ensures that all APIs have contact email."},{"code":"openapi-v3-info-contact-url","status":"passed","message":"Ensures that all APIs have contact URL."},{"code":"openapi-v3-info-license","status":"failed","message":"Ensures that all OpenAPIs have a information object license.","failure":{"message":"The info object should have a license.","path":["info"],"severity":0,"source":"\u003cREQUEST_BODY_0\u003e","range":{"start":{"line":0,"character":26},"end":{"line":0,"character":139}}}},{"code":"openapi-v3-info-license-name","status":"passed","message":"Ensures that all OpenAPIs have a information object license name."},{"code":"openapi-v3-info-license-url","status":"passed","message":"Ensures that all OpenAPIs have a information object license url."},{"code":"openapi-v3-info-license-url-apache","status":"passed","message":"Ensures that all OpenAPIs have a information object license url for Apache."},{"code":"openapi-v3-info-license-url-mit","status":"passed","message":"Ensures that all OpenAPIs have a information object license url for MIT."},{"code":"openapi-v3-info-terms-of-service","status":"failed","message":"Ensures that all OpenAPIs have a information object terms of service.","failure":{"message":"The info object should have a terms of service.","path":["info"],"severity":0,"source":"\u003cREQUEST_BODY_0\u003e","range":{"start":{"line":0,"character":26},"end":{"line":0,"character":139}}}},{"code":"openapi-v3-info-version","status":"passed","message":"Ensures that all OpenAPIs have a information object version."}]