-
-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
06dd98a
commit 5bbbcd3
Showing
2 changed files
with
26 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,73 +1,27 @@ | ||
{ | ||
"description": "The object provides metadata about the API. The metadata can be used by the clients if needed.", | ||
"allOf": [ | ||
{ | ||
"type": "object", | ||
"required": ["version", "title"], | ||
"additionalProperties": false, | ||
"patternProperties": { | ||
"^x-[\\w\\d\\.\\x2d_]+$": { | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/specificationExtension.json" | ||
} | ||
}, | ||
"properties": { | ||
"title": { | ||
"type": "string", | ||
"description": "A unique and precise title of the API." | ||
}, | ||
"version": { | ||
"type": "string", | ||
"description": "A semantic version number of the API." | ||
}, | ||
"description": { | ||
"type": "string", | ||
"description": "A longer description of the API. Should be different from the title. CommonMark is allowed." | ||
}, | ||
"termsOfService": { | ||
"type": "string", | ||
"description": "A URL to the Terms of Service for the API. MUST be in the format of a URL.", | ||
"format": "uri" | ||
}, | ||
"contact": { | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/contact.json" | ||
}, | ||
"license": { | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/license.json" | ||
}, | ||
"tags": { | ||
"type": "array", | ||
"description": "A list of tags for application API documentation control. Tags can be used for logical grouping of applications.", | ||
"items": { | ||
"oneOf": [ | ||
{ | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json" | ||
}, | ||
{ | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/tag.json" | ||
} | ||
] | ||
}, | ||
"uniqueItems": true | ||
}, | ||
"externalDocs": { | ||
"oneOf": [ | ||
{ | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/Reference.json" | ||
}, | ||
{ | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/externalDocs.json" | ||
} | ||
] | ||
} | ||
} | ||
[ | ||
{ | ||
"title": "AsyncAPI Sample App", | ||
"version": "1.0.1", | ||
"description": "This is a sample app.", | ||
"termsOfService": "https://asyncapi.org/terms/", | ||
"contact": { | ||
"name": "API Support", | ||
"url": "https://www.asyncapi.org/support", | ||
"email": "support@asyncapi.org" | ||
}, | ||
"license": { | ||
"name": "Apache 2.0", | ||
"url": "https://www.apache.org/licenses/LICENSE-2.0.html" | ||
}, | ||
{ | ||
"$ref": "http://asyncapi.com/definitions/3.0.0/infoExtensions.json" | ||
} | ||
], | ||
"example": { | ||
"$ref": "http://asyncapi.com/examples/3.0.0/info.json" | ||
}, | ||
"$schema": "http://json-schema.org/draft-07/schema#", | ||
"$id": "http://asyncapi.com/definitions/3.0.0/info.json" | ||
} | ||
"externalDocs": { | ||
"description": "Find more info here", | ||
"url": "https://www.asyncapi.org" | ||
}, | ||
"tags": [ | ||
{ | ||
"name": "e-commerce" | ||
} | ||
] | ||
} | ||
|
||
] |