Skip to content

Commit

Permalink
revert example changes
Browse files Browse the repository at this point in the history
  • Loading branch information
sambhavgupta0705 committed Mar 24, 2024
1 parent 06dd98a commit 5bbbcd3
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 73 deletions.
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,6 @@ Whenever you make changes in AsyncAPI JSON Schema, you should always manually ve
Extensions are a way to [extend AsyncAPI specification](https://www.asyncapi.com/docs/concepts/asyncapi-document/extending-specification) with fields that are not yet defined inside the specification. To add JSON schema of the extension in this repository, you need to first make sure it is added to the [extension-catalog](https://github.com/asyncapi/extensions-catalog) repository.
### How to add schema of the extension


1. All the extensions must be present in [./extensions](./extensions) folder.
2. A proper folder structure must be followed to add the extensions.
3. A new folder just as [x extension](./extensions/x) must be added with proper `versioning` and `schema file`.
Expand Down
98 changes: 26 additions & 72 deletions examples/3.0.0/info.json
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"
}
]
}

]

0 comments on commit 5bbbcd3

Please sign in to comment.