diff --git a/scripts/validation/embedded-examples-validation.js b/scripts/validation/embedded-examples-validation.js index 1dc9b82e..d6a1de89 100644 --- a/scripts/validation/embedded-examples-validation.js +++ b/scripts/validation/embedded-examples-validation.js @@ -46,11 +46,17 @@ function extractCommentsAndExamples(content) { // Extract comments and examples from the markdown file const combinedData = extractCommentsAndExamples(markdownContent); +// Function to convert URI Fragment to JSON Pointer +function uriFragmentToJsonPointer(uriFragment) { + if (uriFragment === '#') return ''; + return uriFragment.slice(1).split('/').map(decodeURIComponent).join('/'); +} + // Function to apply JSON Merge Patch updates to the document function applyUpdates(updates, baseDoc) { updates.forEach(update => { try { - const jsonPointerPath = update.json_pointer; + const jsonPointerPath = uriFragmentToJsonPointer(update.json_pointer); // Handle root document case if (jsonPointerPath === '') { @@ -58,26 +64,11 @@ function applyUpdates(updates, baseDoc) { return; } + // For non-root cases, use jsonpointer to get and set the correct location + const targetObject = jsonpointer.get(baseDoc, jsonPointerPath); + const updatedObject = mergePatch.apply(targetObject || {}, update.example); + jsonpointer.set(baseDoc, jsonPointerPath, updatedObject); - const parentPath = jsonPointerPath.replace(/\/[^/]+$/, '') || '/'; - const targetKey = jsonPointerPath.split('/').pop(); - const parentObject = jsonpointer.get(baseDoc, parentPath) || {}; - - // Check if the target key points to an array - if (Array.isArray(parentObject[targetKey])) { - // Apply patch inside the array - parentObject[targetKey] = parentObject[targetKey].map((item) => { - if (item.name === update.example.name) { - return mergePatch.apply(item, update.example); - } - return item; - }); - } else { - // Apply regular merge if not an array - parentObject[targetKey] = mergePatch.apply(parentObject[targetKey] || {}, update.example); - } - - jsonpointer.set(baseDoc, parentPath, parentObject); } catch (e) { console.error(`\nError processing update for '${update.name}' at path '${update.json_pointer}'`, e); } diff --git a/scripts/validation/ex-doc-v1.md b/scripts/validation/ex-doc-v1.md deleted file mode 100644 index 2942bd04..00000000 --- a/scripts/validation/ex-doc-v1.md +++ /dev/null @@ -1,42 +0,0 @@ -# AsyncAPI Examples - -## Operations Object - -Here is an example of an operations object: - - -```json -{ - "name": "API Support", - "url": "https://www.example.com/support", - "email": "support@example.com" -} -``` - - -```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" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] -} -``` \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channel-Object-json-format.json b/scripts/validation/updated-docs/Channel-Object-json-format.json deleted file mode 100644 index 1819e32b..00000000 --- a/scripts/validation/updated-docs/Channel-Object-json-format.json +++ /dev/null @@ -1,692 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/rabbitmqInProd" - }, - { - "$ref": "#/servers/rabbitmqInStaging" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channel-Object-yaml-format.json b/scripts/validation/updated-docs/Channel-Object-yaml-format.json deleted file mode 100644 index 1819e32b..00000000 --- a/scripts/validation/updated-docs/Channel-Object-yaml-format.json +++ /dev/null @@ -1,692 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/rabbitmqInProd" - }, - { - "$ref": "#/servers/rabbitmqInStaging" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channel-Parameter-Object-json-format.json b/scripts/validation/updated-docs/Channel-Parameter-Object-json-format.json deleted file mode 100644 index 53c10327..00000000 --- a/scripts/validation/updated-docs/Channel-Parameter-Object-json-format.json +++ /dev/null @@ -1,691 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "user/{userId}/signedup", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId", - "description": "Id of the user.", - "location": "$message.payload#/user/id" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channel-Parameter-Object-yaml-format.json b/scripts/validation/updated-docs/Channel-Parameter-Object-yaml-format.json deleted file mode 100644 index 53c10327..00000000 --- a/scripts/validation/updated-docs/Channel-Parameter-Object-yaml-format.json +++ /dev/null @@ -1,691 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "user/{userId}/signedup", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId", - "description": "Id of the user.", - "location": "$message.payload#/user/id" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channel-Parameters-Object-json-format.json b/scripts/validation/updated-docs/Channel-Parameters-Object-json-format.json deleted file mode 100644 index 91d426d6..00000000 --- a/scripts/validation/updated-docs/Channel-Parameters-Object-json-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "user/{userId}/signedup", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId", - "description": "Id of the user." - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channel-Parameters-Object-yaml-format.json b/scripts/validation/updated-docs/Channel-Parameters-Object-yaml-format.json deleted file mode 100644 index 91d426d6..00000000 --- a/scripts/validation/updated-docs/Channel-Parameters-Object-yaml-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "user/{userId}/signedup", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId", - "description": "Id of the user." - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channels-Object-json-format.json b/scripts/validation/updated-docs/Channels-Object-json-format.json deleted file mode 100644 index 0886aeb7..00000000 --- a/scripts/validation/updated-docs/Channels-Object-json-format.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - }, - "userSignedUp": { - "address": "user.signedup", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Channels-Object-yaml-format.json b/scripts/validation/updated-docs/Channels-Object-yaml-format.json deleted file mode 100644 index 0886aeb7..00000000 --- a/scripts/validation/updated-docs/Channels-Object-yaml-format.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - }, - "userSignedUp": { - "address": "user.signedup", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Components-Object-json-format.json b/scripts/validation/updated-docs/Components-Object-json-format.json deleted file mode 100644 index d10b13cd..00000000 --- a/scripts/validation/updated-docs/Components-Object-json-format.json +++ /dev/null @@ -1,750 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ], - "$ref": "path/to/user-create.avsc#/UserCreate" - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Tag": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com:{port}", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - }, - "port": { - "$ref": "#/components/serverVariables/port" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ], - "protocolVersion": "0-9-1" - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider, in this example `mycompany.com`" - }, - "port": { - "enum": [ - "5671", - "5672" - ], - "default": "5672" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - }, - "user/signedup": { - "subscribe": { - "message": { - "$ref": "#/components/messages/userSignUp" - } - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category", - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [], - "description": "Multiline description of what this action does.\nHere you have another line.\n", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - } - ], - "headers": { - "type": "object", - "properties": { - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Components-Object-yaml-format.json b/scripts/validation/updated-docs/Components-Object-yaml-format.json deleted file mode 100644 index e7d9be08..00000000 --- a/scripts/validation/updated-docs/Components-Object-yaml-format.json +++ /dev/null @@ -1,750 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ], - "$ref": "path/to/user-create.avsc/#UserCreate" - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Tag": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com:{port}", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - }, - "port": { - "$ref": "#/components/serverVariables/port" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ], - "protocolVersion": "0-9-1" - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider, in this example `mycompany.com`" - }, - "port": { - "enum": [ - "5671", - "5672" - ], - "default": "5672" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - }, - "user/signedup": { - "subscribe": { - "message": { - "$ref": "#/components/messages/userSignUp" - } - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category", - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [], - "description": "Multiline description of what this action does.\nHere you have another line.\n", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - } - ], - "headers": { - "type": "object", - "properties": { - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Contact-Object-json-format.json b/scripts/validation/updated-docs/Contact-Object-json-format.json deleted file mode 100644 index 6d94699e..00000000 --- a/scripts/validation/updated-docs/Contact-Object-json-format.json +++ /dev/null @@ -1,694 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ], - "contact": { - "name": "API Support", - "url": "https://www.example.com/support", - "email": "support@example.com" - } - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Contact-Object-yaml-format.json b/scripts/validation/updated-docs/Contact-Object-yaml-format.json deleted file mode 100644 index 6d94699e..00000000 --- a/scripts/validation/updated-docs/Contact-Object-yaml-format.json +++ /dev/null @@ -1,694 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ], - "contact": { - "name": "API Support", - "url": "https://www.example.com/support", - "email": "support@example.com" - } - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Default-Content-Type-at-root-doc-json-format.json b/scripts/validation/updated-docs/Default-Content-Type-at-root-doc-json-format.json deleted file mode 100644 index 07f5ef5e..00000000 --- a/scripts/validation/updated-docs/Default-Content-Type-at-root-doc-json-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - }, - "defaultContentType": "application/json" -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Default-Content-Type-at-root-doc-yaml-format.json b/scripts/validation/updated-docs/Default-Content-Type-at-root-doc-yaml-format.json deleted file mode 100644 index 07f5ef5e..00000000 --- a/scripts/validation/updated-docs/Default-Content-Type-at-root-doc-yaml-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - }, - "defaultContentType": "application/json" -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/External-Docs-Object-json-format.json b/scripts/validation/updated-docs/External-Docs-Object-json-format.json deleted file mode 100644 index 553e34c9..00000000 --- a/scripts/validation/updated-docs/External-Docs-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/External-Docs-Object-yaml-format.json b/scripts/validation/updated-docs/External-Docs-Object-yaml-format.json deleted file mode 100644 index 553e34c9..00000000 --- a/scripts/validation/updated-docs/External-Docs-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Info-Object-json-format.json b/scripts/validation/updated-docs/Info-Object-json-format.json deleted file mode 100644 index 8fdd4ac8..00000000 --- a/scripts/validation/updated-docs/Info-Object-json-format.json +++ /dev/null @@ -1,694 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI Sample App", - "version": "1.0.1", - "description": "This is a sample app.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ], - "contact": { - "name": "API Support", - "url": "https://www.asyncapi.org/support", - "email": "support@asyncapi.org" - } - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Info-Object-yaml-format.json b/scripts/validation/updated-docs/Info-Object-yaml-format.json deleted file mode 100644 index 8fdd4ac8..00000000 --- a/scripts/validation/updated-docs/Info-Object-yaml-format.json +++ /dev/null @@ -1,694 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI Sample App", - "version": "1.0.1", - "description": "This is a sample app.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ], - "contact": { - "name": "API Support", - "url": "https://www.asyncapi.org/support", - "email": "support@asyncapi.org" - } - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/License-Object-json-format.json b/scripts/validation/updated-docs/License-Object-json-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/License-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/License-Object-yaml-format.json b/scripts/validation/updated-docs/License-Object-yaml-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/License-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Correlation-ID-Object-json-format.json b/scripts/validation/updated-docs/Message-Correlation-ID-Object-json-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/Message-Correlation-ID-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Correlation-ID-Object-yaml-format.json b/scripts/validation/updated-docs/Message-Correlation-ID-Object-yaml-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/Message-Correlation-ID-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Example-Object-json-format.json b/scripts/validation/updated-docs/Message-Example-Object-json-format.json deleted file mode 100644 index ed7ff974..00000000 --- a/scripts/validation/updated-docs/Message-Example-Object-json-format.json +++ /dev/null @@ -1,706 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Example-Object-yaml-format.json b/scripts/validation/updated-docs/Message-Example-Object-yaml-format.json deleted file mode 100644 index ed7ff974..00000000 --- a/scripts/validation/updated-docs/Message-Example-Object-yaml-format.json +++ /dev/null @@ -1,706 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Object-json-format.json b/scripts/validation/updated-docs/Message-Object-json-format.json deleted file mode 100644 index 68fb56b4..00000000 --- a/scripts/validation/updated-docs/Message-Object-json-format.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - }, - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "$ref": "path/to/user-create.avsc#/UserCreate" - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Object-yaml-format.json b/scripts/validation/updated-docs/Message-Object-yaml-format.json deleted file mode 100644 index ef0f16aa..00000000 --- a/scripts/validation/updated-docs/Message-Object-yaml-format.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - }, - "schemaFormat": "application/vnd.apache.avro+yaml;version=1.9.0", - "schema": { - "$ref": "path/to/user-create.avsc/#UserCreate" - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Trait-Object-json-format.json b/scripts/validation/updated-docs/Message-Trait-Object-json-format.json deleted file mode 100644 index ae0708be..00000000 --- a/scripts/validation/updated-docs/Message-Trait-Object-json-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - }, - "contentType": "application/json" - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Message-Trait-Object-yaml-format.json b/scripts/validation/updated-docs/Message-Trait-Object-yaml-format.json deleted file mode 100644 index ae0708be..00000000 --- a/scripts/validation/updated-docs/Message-Trait-Object-yaml-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - }, - "contentType": "application/json" - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Messages-Object-json-format.json b/scripts/validation/updated-docs/Messages-Object-json-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/Messages-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Messages-Object-yaml-format.json b/scripts/validation/updated-docs/Messages-Object-yaml-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/Messages-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Muti-Format-Schema-Object---Avro-yaml-format.json b/scripts/validation/updated-docs/Muti-Format-Schema-Object---Avro-yaml-format.json deleted file mode 100644 index b55dc4f4..00000000 --- a/scripts/validation/updated-docs/Muti-Format-Schema-Object---Avro-yaml-format.json +++ /dev/null @@ -1,714 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - }, - "example": { - "messages": { - "myMessage": { - "payload": { - "schemaFormat": "application/vnd.apache.avro;version=1.9.0", - "schema": { - "type": "record", - "name": "User", - "namespace": "com.company", - "doc": "User information", - "fields": [ - { - "name": "displayName", - "type": "string" - }, - { - "name": "age", - "type": "int" - } - ] - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operation-Object-json-format.json b/scripts/validation/updated-docs/Operation-Object-json-format.json deleted file mode 100644 index 28120000..00000000 --- a/scripts/validation/updated-docs/Operation-Object-json-format.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/userSignup" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ], - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "/components/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "/components/messages/userSignedUpReply" - } - ] - }, - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operation-Object-yaml-format.json b/scripts/validation/updated-docs/Operation-Object-yaml-format.json deleted file mode 100644 index 67acb32d..00000000 --- a/scripts/validation/updated-docs/Operation-Object-yaml-format.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/userSignup" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ], - "petstore_auth": [ - "write:pets", - "read:pets" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/components/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/components/messages/userSignedUpReply" - } - ] - }, - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operation-Reply-Address-Object-json-format.json b/scripts/validation/updated-docs/Operation-Reply-Address-Object-json-format.json deleted file mode 100644 index 74b52763..00000000 --- a/scripts/validation/updated-docs/Operation-Reply-Address-Object-json-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo", - "description": "Consumer inbox" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operation-Reply-Address-Object-yaml-format.json b/scripts/validation/updated-docs/Operation-Reply-Address-Object-yaml-format.json deleted file mode 100644 index 9dd142e1..00000000 --- a/scripts/validation/updated-docs/Operation-Reply-Address-Object-yaml-format.json +++ /dev/null @@ -1,690 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo", - "description": "Consumer Inbox" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operation-Traits-Object-json-format.json b/scripts/validation/updated-docs/Operation-Traits-Object-json-format.json deleted file mode 100644 index f71f5900..00000000 --- a/scripts/validation/updated-docs/Operation-Traits-Object-json-format.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [ - { - "bindings": { - "amqp": { - "ack": false - } - } - } - ] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operation-Traits-Object-yaml-format.json b/scripts/validation/updated-docs/Operation-Traits-Object-yaml-format.json deleted file mode 100644 index f71f5900..00000000 --- a/scripts/validation/updated-docs/Operation-Traits-Object-yaml-format.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [ - { - "bindings": { - "amqp": { - "ack": false - } - } - } - ] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operations-Object-json-format.json b/scripts/validation/updated-docs/Operations-Object-json-format.json deleted file mode 100644 index f114d80b..00000000 --- a/scripts/validation/updated-docs/Operations-Object-json-format.json +++ /dev/null @@ -1,719 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - }, - "onUserSignUp": { - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/userSignup" - }, - "action": "send", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Operations-Object-yaml-format.json b/scripts/validation/updated-docs/Operations-Object-yaml-format.json deleted file mode 100644 index f114d80b..00000000 --- a/scripts/validation/updated-docs/Operations-Object-yaml-format.json +++ /dev/null @@ -1,719 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - }, - "onUserSignUp": { - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/userSignup" - }, - "action": "send", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "traits": [ - { - "$ref": "#/components/operationTraits/kafka" - } - ] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Reference-Object-json-format.json b/scripts/validation/updated-docs/Reference-Object-json-format.json deleted file mode 100644 index 42c29fbe..00000000 --- a/scripts/validation/updated-docs/Reference-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Pet" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Reference-Object-yaml-format.json b/scripts/validation/updated-docs/Reference-Object-yaml-format.json deleted file mode 100644 index 42c29fbe..00000000 --- a/scripts/validation/updated-docs/Reference-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Pet" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-json-format.json deleted file mode 100644 index 35d88c1d..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-json-format.json +++ /dev/null @@ -1,695 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithComplex": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ComplexModel" - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-yaml-format.json deleted file mode 100644 index 35d88c1d..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-yaml-format.json +++ /dev/null @@ -1,695 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithComplex": { - "type": "object", - "additionalProperties": { - "$ref": "#/components/schemas/ComplexModel" - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-json-format.json deleted file mode 100644 index 0c8e8bab..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-json-format.json +++ /dev/null @@ -1,695 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Additional": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-yaml-format.json deleted file mode 100644 index 0c8e8bab..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-yaml-format.json +++ /dev/null @@ -1,695 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Additional": { - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Primitive-json-format.json b/scripts/validation/updated-docs/Schema-Object---Primitive-json-format.json deleted file mode 100644 index 748640f3..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Primitive-json-format.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Email": { - "type": "string", - "format": "email" - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Primitive-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---Primitive-yaml-format.json deleted file mode 100644 index 748640f3..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Primitive-yaml-format.json +++ /dev/null @@ -1,693 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Email": { - "type": "string", - "format": "email" - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Simple-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---Simple-model-json-format.json deleted file mode 100644 index 7bb535a5..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Simple-model-json-format.json +++ /dev/null @@ -1,708 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Person": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "address": { - "$ref": "#/components/schemas/Address" - }, - "age": { - "type": "integer", - "format": "int32", - "minimum": 0 - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---Simple-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---Simple-model-yaml-format.json deleted file mode 100644 index 7bb535a5..00000000 --- a/scripts/validation/updated-docs/Schema-Object---Simple-model-yaml-format.json +++ /dev/null @@ -1,708 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "Person": { - "type": "object", - "required": [ - "name" - ], - "properties": { - "name": { - "type": "string" - }, - "address": { - "$ref": "#/components/schemas/Address" - }, - "age": { - "type": "integer", - "format": "int32", - "minimum": 0 - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-boolean-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---With-boolean-model-json-format.json deleted file mode 100644 index 8ba86715..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-boolean-model-json-format.json +++ /dev/null @@ -1,699 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithBoolean": { - "type": "object", - "required": [ - "anySchema" - ], - "properties": { - "anySchema": true, - "cannotBeDefined": false - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-boolean-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---With-boolean-model-yaml-format.json deleted file mode 100644 index 8ba86715..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-boolean-model-yaml-format.json +++ /dev/null @@ -1,699 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithBoolean": { - "type": "object", - "required": [ - "anySchema" - ], - "properties": { - "anySchema": true, - "cannotBeDefined": false - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-composition-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---With-composition-model-json-format.json deleted file mode 100644 index 1dc47db1..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-composition-model-json-format.json +++ /dev/null @@ -1,728 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithComposition": { - "schemas": { - "ErrorModel": { - "type": "object", - "required": [ - "message", - "code" - ], - "properties": { - "message": { - "type": "string" - }, - "code": { - "type": "integer", - "minimum": 100, - "maximum": 600 - } - } - }, - "ExtendedErrorModel": { - "allOf": [ - { - "$ref": "#/components/schemas/ErrorModel" - }, - { - "type": "object", - "required": [ - "rootCause" - ], - "properties": { - "rootCause": { - "type": "string" - } - } - } - ] - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-composition-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---With-composition-model-yaml-format.json deleted file mode 100644 index 1dc47db1..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-composition-model-yaml-format.json +++ /dev/null @@ -1,728 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithComposition": { - "schemas": { - "ErrorModel": { - "type": "object", - "required": [ - "message", - "code" - ], - "properties": { - "message": { - "type": "string" - }, - "code": { - "type": "integer", - "minimum": 100, - "maximum": 600 - } - } - }, - "ExtendedErrorModel": { - "allOf": [ - { - "$ref": "#/components/schemas/ErrorModel" - }, - { - "type": "object", - "required": [ - "rootCause" - ], - "properties": { - "rootCause": { - "type": "string" - } - } - } - ] - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-examples-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---With-examples-model-json-format.json deleted file mode 100644 index 85a56bbb..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-examples-model-json-format.json +++ /dev/null @@ -1,710 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithExamples": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name" - ], - "examples": [ - { - "name": "Puma", - "id": 1 - } - ] - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-examples-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---With-examples-model-yaml-format.json deleted file mode 100644 index 85a56bbb..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-examples-model-yaml-format.json +++ /dev/null @@ -1,710 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithExamples": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - }, - "required": [ - "name" - ], - "examples": [ - { - "name": "Puma", - "id": 1 - } - ] - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-json-format.json b/scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-json-format.json deleted file mode 100644 index 5aaac595..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-json-format.json +++ /dev/null @@ -1,779 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithPolymorphism": { - "schemas": { - "Pet": { - "type": "object", - "discriminator": "petType", - "properties": { - "name": { - "type": "string" - }, - "petType": { - "type": "string" - } - }, - "required": [ - "name", - "petType" - ] - }, - "Cat": { - "description": "A representation of a cat. Note that `Cat` will be used as the discriminator value.", - "allOf": [ - { - "$ref": "#/components/schemas/Pet" - }, - { - "type": "object", - "properties": { - "huntingSkill": { - "type": "string", - "description": "The measured skill for hunting", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] - } - }, - "required": [ - "huntingSkill" - ] - } - ] - }, - "Dog": { - "description": "A representation of a dog. Note that `Dog` will be used as the discriminator value.", - "allOf": [ - { - "$ref": "#/components/schemas/Pet" - }, - { - "type": "object", - "properties": { - "packSize": { - "type": "integer", - "format": "int32", - "description": "the size of the pack the dog is from", - "minimum": 0 - } - }, - "required": [ - "packSize" - ] - } - ] - }, - "StickInsect": { - "description": "A representation of an Australian walking stick. Note that `StickBug` will be used as the discriminator value.", - "allOf": [ - { - "$ref": "#/components/schemas/Pet" - }, - { - "type": "object", - "properties": { - "petType": { - "const": "StickBug" - }, - "color": { - "type": "string" - } - }, - "required": [ - "color" - ] - } - ] - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-yaml-format.json b/scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-yaml-format.json deleted file mode 100644 index 9a98a1ff..00000000 --- a/scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-yaml-format.json +++ /dev/null @@ -1,779 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - }, - "WithPolymorphism": { - "schemas": { - "Pet": { - "type": "object", - "discriminator": "petType", - "properties": { - "name": { - "type": "string" - }, - "petType": { - "type": "string" - } - }, - "required": [ - "name", - "petType" - ] - }, - "Cat": { - "description": "A representation of a cat", - "allOf": [ - { - "$ref": "#/components/schemas/Pet" - }, - { - "type": "object", - "properties": { - "huntingSkill": { - "type": "string", - "description": "The measured skill for hunting", - "enum": [ - "clueless", - "lazy", - "adventurous", - "aggressive" - ] - } - }, - "required": [ - "huntingSkill" - ] - } - ] - }, - "Dog": { - "description": "A representation of a dog", - "allOf": [ - { - "$ref": "#/components/schemas/Pet" - }, - { - "type": "object", - "properties": { - "packSize": { - "type": "integer", - "format": "int32", - "description": "the size of the pack the dog is from", - "minimum": 0 - } - }, - "required": [ - "packSize" - ] - } - ] - }, - "StickInsect": { - "description": "A representation of an Australian walking stick", - "allOf": [ - { - "$ref": "#/components/schemas/Pet" - }, - { - "type": "object", - "properties": { - "petType": { - "const": "StickBug" - }, - "color": { - "type": "string" - } - }, - "required": [ - "color" - ] - } - ] - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-json-format.json b/scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-json-format.json deleted file mode 100644 index fc919a87..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-json-format.json +++ /dev/null @@ -1,692 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/token", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic", - "write:pets": "modify pets in your account", - "read:pets": "read your pets" - }, - "authorizationUrl": "https://example.com/api/oauth/dialog" - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-yaml-format.json deleted file mode 100644 index fc919a87..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-yaml-format.json +++ /dev/null @@ -1,692 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/token", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic", - "write:pets": "modify pets in your account", - "read:pets": "read your pets" - }, - "authorizationUrl": "https://example.com/api/oauth/dialog" - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-json-format.json deleted file mode 100644 index db223349..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-json-format.json +++ /dev/null @@ -1,648 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "apiKey", - "description": "The oauth security descriptions", - "in": "user" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-yaml-format.json deleted file mode 100644 index db223349..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-yaml-format.json +++ /dev/null @@ -1,648 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "apiKey", - "description": "The oauth security descriptions", - "in": "user" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---API-key-json-format.json deleted file mode 100644 index 2d0a1e15..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-json-format.json +++ /dev/null @@ -1,649 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "httpApiKey", - "description": "The oauth security descriptions", - "name": "api_key", - "in": "header" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---API-key-yaml-format.json deleted file mode 100644 index 2d0a1e15..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---API-key-yaml-format.json +++ /dev/null @@ -1,649 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "httpApiKey", - "description": "The oauth security descriptions", - "name": "api_key", - "in": "header" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---JWT-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---JWT-json-format.json deleted file mode 100644 index 94c1dbcf..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---JWT-json-format.json +++ /dev/null @@ -1,649 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "http", - "description": "The oauth security descriptions", - "scheme": "bearer", - "bearerFormat": "JWT" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---JWT-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---JWT-yaml-format.json deleted file mode 100644 index 94c1dbcf..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---JWT-yaml-format.json +++ /dev/null @@ -1,649 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "http", - "description": "The oauth security descriptions", - "scheme": "bearer", - "bearerFormat": "JWT" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---SASL-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---SASL-json-format.json deleted file mode 100644 index 207899a2..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---SASL-json-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "scramSha512", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---SASL-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---SASL-yaml-format.json deleted file mode 100644 index 207899a2..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---SASL-yaml-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "scramSha512", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---X509-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---X509-json-format.json deleted file mode 100644 index cf99803e..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---X509-json-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "X509", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---X509-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---X509-yaml-format.json deleted file mode 100644 index cf99803e..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---X509-yaml-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "X509", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---basic-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---basic-json-format.json deleted file mode 100644 index 4b415525..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---basic-json-format.json +++ /dev/null @@ -1,648 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "http", - "description": "The oauth security descriptions", - "scheme": "basic" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---basic-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---basic-yaml-format.json deleted file mode 100644 index 4b415525..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---basic-yaml-format.json +++ /dev/null @@ -1,648 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "http", - "description": "The oauth security descriptions", - "scheme": "basic" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-json-format.json deleted file mode 100644 index d2d75cdb..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-json-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "symmetricEncryption", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-yaml-format.json deleted file mode 100644 index d2d75cdb..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-yaml-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "symmetricEncryption", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-json-format.json deleted file mode 100644 index 8024f4c8..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-json-format.json +++ /dev/null @@ -1,659 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "implicit": { - "authorizationUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "write:pets": "modify pets in your account", - "read:pets": "read your pets" - } - } - }, - "scopes": [ - "write:pets" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-yaml-format.json deleted file mode 100644 index 8024f4c8..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-yaml-format.json +++ /dev/null @@ -1,659 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "implicit": { - "authorizationUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "write:pets": "modify pets in your account", - "read:pets": "read your pets" - } - } - }, - "scopes": [ - "write:pets" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---user-pass-json-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---user-pass-json-format.json deleted file mode 100644 index 89ad3436..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---user-pass-json-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "userPassword", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Security-Scheme-Object---user-pass-yaml-format.json b/scripts/validation/updated-docs/Security-Scheme-Object---user-pass-yaml-format.json deleted file mode 100644 index 89ad3436..00000000 --- a/scripts/validation/updated-docs/Security-Scheme-Object---user-pass-yaml-format.json +++ /dev/null @@ -1,647 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - } - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - } - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "userPassword", - "description": "The oauth security descriptions" - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Server-Object-json-format.json b/scripts/validation/updated-docs/Server-Object-json-format.json deleted file mode 100644 index a8f1c095..00000000 --- a/scripts/validation/updated-docs/Server-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "kafka.in.mycompany.com:9092", - "pathname": "/v1", - "protocol": "kafka", - "protocolVersion": "3.2", - "description": "Production Kafka broker.", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Server-Object-with-Variable-Object-json-format.json b/scripts/validation/updated-docs/Server-Object-with-Variable-Object-json-format.json deleted file mode 100644 index f3a35600..00000000 --- a/scripts/validation/updated-docs/Server-Object-with-Variable-Object-json-format.json +++ /dev/null @@ -1,698 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/{env}", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "RabbitMQ broker. Use the `env` variable to point to either `production` or `staging`.", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - }, - "variables": { - "env": { - "description": "Environment to connect to. It can be either `production` or `staging`.", - "enum": [ - "production", - "staging" - ] - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Server-Object-with-Variable-Object-yaml-format.json b/scripts/validation/updated-docs/Server-Object-with-Variable-Object-yaml-format.json deleted file mode 100644 index f3a35600..00000000 --- a/scripts/validation/updated-docs/Server-Object-with-Variable-Object-yaml-format.json +++ /dev/null @@ -1,698 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/{env}", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "RabbitMQ broker. Use the `env` variable to point to either `production` or `staging`.", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - }, - "variables": { - "env": { - "description": "Environment to connect to. It can be either `production` or `staging`.", - "enum": [ - "production", - "staging" - ] - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Server-Object-with-pathname-json-format.json b/scripts/validation/updated-docs/Server-Object-with-pathname-json-format.json deleted file mode 100644 index 8ae8ad54..00000000 --- a/scripts/validation/updated-docs/Server-Object-with-pathname-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/production", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Server-Object-with-pathname-yaml-format.json b/scripts/validation/updated-docs/Server-Object-with-pathname-yaml-format.json deleted file mode 100644 index 8ae8ad54..00000000 --- a/scripts/validation/updated-docs/Server-Object-with-pathname-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/production", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Server-Object-yaml-format.json b/scripts/validation/updated-docs/Server-Object-yaml-format.json deleted file mode 100644 index a8f1c095..00000000 --- a/scripts/validation/updated-docs/Server-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "kafka.in.mycompany.com:9092", - "pathname": "/v1", - "protocol": "kafka", - "protocolVersion": "3.2", - "description": "Production Kafka broker.", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Servers-Object-json-format.json b/scripts/validation/updated-docs/Servers-Object-json-format.json deleted file mode 100644 index a04b6a1f..00000000 --- a/scripts/validation/updated-docs/Servers-Object-json-format.json +++ /dev/null @@ -1,701 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "0-9-1", - "description": "RabbitMQ broker for the production environment.", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "env:production", - "description": "This environment is the live environment available for final users." - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq-staging.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "0-9-1", - "description": "RabbitMQ broker for the staging environment.", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "env:staging", - "description": "This environment is a replica of the production environment." - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - }, - "development": { - "host": "localhost:5672", - "description": "Development AMQP broker.", - "protocol": "amqp", - "protocolVersion": "0-9-1", - "tags": [ - { - "name": "env:development", - "description": "This environment is meant for developers to run their own tests." - } - ] - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Servers-Object-yaml-format.json b/scripts/validation/updated-docs/Servers-Object-yaml-format.json deleted file mode 100644 index a04b6a1f..00000000 --- a/scripts/validation/updated-docs/Servers-Object-yaml-format.json +++ /dev/null @@ -1,701 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "0-9-1", - "description": "RabbitMQ broker for the production environment.", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "env:production", - "description": "This environment is the live environment available for final users." - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq-staging.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "0-9-1", - "description": "RabbitMQ broker for the staging environment.", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "env:staging", - "description": "This environment is a replica of the production environment." - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - }, - "development": { - "host": "localhost:5672", - "description": "Development AMQP broker.", - "protocol": "amqp", - "protocolVersion": "0-9-1", - "tags": [ - { - "name": "env:development", - "description": "This environment is meant for developers to run their own tests." - } - ] - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Tag-Object-json-format.json b/scripts/validation/updated-docs/Tag-Object-json-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/Tag-Object-json-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/scripts/validation/updated-docs/Tag-Object-yaml-format.json b/scripts/validation/updated-docs/Tag-Object-yaml-format.json deleted file mode 100644 index 0fecde4f..00000000 --- a/scripts/validation/updated-docs/Tag-Object-yaml-format.json +++ /dev/null @@ -1,689 +0,0 @@ -{ - "asyncapi": "3.0.0", - "info": { - "title": "AsyncAPI", - "version": "1.x.x", - "description": "This is a very good base doc, probably.", - "termsOfService": "https://asyncapi.org/terms/", - "license": { - "name": "Apache 2.0", - "url": "https://www.apache.org/licenses/LICENSE-2.0.html" - }, - "externalDocs": { - "description": "Find more info here", - "url": "https://www.asyncapi.org" - }, - "tags": [ - { - "name": "e-commerce" - } - ] - }, - "servers": { - "production": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Production RabbitMQ broker (uses the `production` vhost).", - "title": "Production Server", - "summary": "Production environment server", - "security": [ - { - "type": "http", - "scheme": "bearer" - } - ], - "tags": [ - { - "name": "production", - "description": "Production environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the production server", - "url": "https://example.com/docs/production" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "staging": { - "host": "rabbitmq.in.mycompany.com:5672", - "pathname": "/v1", - "protocol": "amqp", - "protocolVersion": "1.0", - "description": "Staging RabbitMQ broker (uses the `staging` vhost).", - "title": "Staging Server", - "summary": "Staging environment server", - "security": [ - { - "type": "apiKey", - "in": "user", - "description": "Provide your API key as the user and leave the password empty." - } - ], - "tags": [ - { - "name": "staging", - "description": "Staging environment" - } - ], - "externalDocs": { - "description": "Additional documentation for the staging server", - "url": "https://example.com/docs/staging" - }, - "bindings": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "rabbitmqInProd": { - "host": "{prod}.in.mycompany.com", - "protocol": "amqp", - "description": "Production server" - }, - "rabbitmqInStaging": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "Staging server" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - }, - "userCompletedOrder": { - "$ref": "#/components/messages/userCompletedOrder" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/servers/production" - } - ], - "bindings": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - }, - "tags": [ - { - "name": "user", - "description": "User-related messages" - } - ], - "externalDocs": { - "description": "Find more info here", - "url": "https://example.com" - } - }, - "userSignup": { - "address": "users.signup", - "description": "Channel for user signups", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignedUp" - } - } - }, - "userSignupReply": { - "address": "users.signup.reply", - "description": "Channel for user signup replies", - "messages": { - "userSignedUpReply": { - "summary": "User signup reply message", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - } - } - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "summary": "Action to sign a user up.", - "description": "A longer description", - "channel": { - "$ref": "#/channels/user" - }, - "security": [ - { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - ], - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "bindings": { - "amqp": { - "ack": false - } - }, - "messages": [ - { - "$ref": "#/channels/user/messages/userSignedUp" - } - ], - "reply": { - "address": { - "location": "$message.header#/replyTo" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - }, - "messages": [ - { - "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" - } - ] - }, - "traits": [] - } - }, - "components": { - "schemas": { - "Category": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - } - } - }, - "AvroExample": { - "schemaFormat": "application/vnd.apache.avro+json;version=1.9.0", - "schema": { - "type": "record", - "name": "UserCreate", - "namespace": "com.example", - "fields": [ - { - "name": "id", - "type": "int" - }, - { - "name": "name", - "type": "string" - } - ] - } - }, - "userCreate": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "The ID of the user" - }, - "name": { - "type": "string", - "description": "The name of the user" - }, - "email": { - "type": "string", - "format": "email", - "description": "The email of the user" - } - }, - "required": [ - "id", - "name", - "email" - ] - }, - "signup": { - "type": "object", - "properties": { - "timestamp": { - "type": "string", - "format": "date-time", - "description": "The timestamp of the signup" - }, - "source": { - "type": "string", - "description": "The source of the signup" - } - }, - "required": [ - "timestamp", - "source" - ] - }, - "ComplexModel": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - } - } - }, - "Address": { - "type": "object", - "properties": { - "street": { - "type": "string" - }, - "city": { - "type": "string" - }, - "state": { - "type": "string" - }, - "zip": { - "type": "string" - } - } - }, - "ErrorModel": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - }, - "Pet": { - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "tag": { - "type": "string" - } - } - } - }, - "servers": { - "development": { - "host": "{stage}.in.mycompany.com", - "protocol": "amqp", - "description": "RabbitMQ broker", - "bindings": { - "$ref": "#/components/serverBindings/devAmqp" - }, - "variables": { - "stage": { - "$ref": "#/components/serverVariables/stage" - } - }, - "security": [ - { - "$ref": "#/components/securitySchemes/oauth" - } - ] - } - }, - "serverVariables": { - "stage": { - "default": "demo", - "description": "This value is assigned by the service provider in this example of `mycompany.com`" - } - }, - "channels": { - "user": { - "address": "users.{userId}", - "title": "Users channel", - "description": "This channel is used to exchange messages about user events.", - "messages": { - "userSignedUp": { - "$ref": "#/components/messages/userSignUp" - } - }, - "parameters": { - "userId": { - "$ref": "#/components/parameters/userId" - } - }, - "servers": [ - { - "$ref": "#/components/servers/development" - } - ], - "bindings": { - "$ref": "#/components/channelBindings/user" - }, - "tags": [ - { - "$ref": "#/components/tags/user" - } - ], - "externalDocs": { - "$ref": "#/components/externalDocs/infoDocs" - } - } - }, - "messages": { - "userSignUp": { - "summary": "Action to sign a user up.", - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "payload": { - "$ref": "#/components/schemas/Category" - }, - "correlationId": { - "$ref": "#/components/correlationIds/default" - }, - "bindings": { - "$ref": "#/components/messageBindings/user" - }, - "examples": [] - }, - "userSignedUp": { - "name": "UserSignup", - "title": "User signup", - "summary": "Action to sign a user up.", - "description": "A longer description", - "contentType": "application/json", - "tags": [ - { - "name": "user" - }, - { - "name": "signup" - }, - { - "name": "register" - } - ], - "headers": { - "type": "object", - "properties": { - "correlationId": { - "description": "Correlation ID set by application", - "type": "string" - }, - "applicationInstanceId": { - "description": "Unique identifier for a given instance of the publishing application", - "type": "string" - } - } - }, - "payload": { - "type": "object", - "properties": { - "user": { - "$ref": "#/components/schemas/userCreate" - }, - "signup": { - "$ref": "#/components/schemas/signup" - } - } - }, - "correlationId": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - }, - "traits": [ - { - "$ref": "#/components/messageTraits/commonHeaders" - } - ], - "examples": [ - { - "name": "SimpleSignup", - "summary": "A simple UserSignup example message", - "headers": { - "correlationId": "my-correlation-id", - "applicationInstanceId": "myInstanceId" - }, - "payload": { - "user": { - "someUserKey": "someUserValue" - }, - "signup": { - "someSignupKey": "someSignupValue" - } - } - } - ] - }, - "userSignedUpReply": { - "name": "UserSignupReply", - "title": "User signup reply", - "summary": "User signup reply message", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "status": { - "type": "string", - "description": "Status of the signup process" - }, - "message": { - "type": "string", - "description": "Additional information" - } - } - } - }, - "userCompletedOrder": { - "summary": "User completed order event", - "contentType": "application/json", - "payload": { - "type": "object", - "properties": { - "orderId": { - "type": "string", - "description": "The ID of the order" - }, - "userId": { - "type": "string", - "description": "The ID of the user" - }, - "amount": { - "type": "number", - "description": "The total amount of the order" - } - } - } - } - }, - "parameters": { - "userId": { - "description": "Id of the user." - } - }, - "correlationIds": { - "default": { - "description": "Default Correlation ID", - "location": "$message.header#/correlationId" - } - }, - "operations": { - "sendUserSignUp": { - "action": "send", - "title": "User sign up", - "channel": { - "$ref": "#/channels/user" - }, - "bindings": { - "$ref": "#/components/operationBindings/sendUser" - }, - "traits": [ - { - "$ref": "#/components/operationTraits/binding" - } - ], - "reply": { - "$ref": "#/components/replies/signupReply" - } - } - }, - "replies": { - "signupReply": { - "address": { - "$ref": "#/components/replyAddresses/signupReply" - }, - "channel": { - "$ref": "#/channels/userSignupReply" - } - } - }, - "replyAddresses": { - "signupReply": { - "location": "$message.header#/replyTo" - } - }, - "securitySchemes": { - "oauth": { - "type": "oauth2", - "description": "The oauth security descriptions", - "flows": { - "clientCredentials": { - "tokenUrl": "https://example.com/api/oauth/dialog", - "availableScopes": { - "subscribe:auth_revocations": "Scope required for authorization revocation topic" - } - } - }, - "scopes": [ - "subscribe:auth_revocations" - ] - } - }, - "operationTraits": { - "binding": { - "bindings": { - "amqp": { - "ack": false - } - } - }, - "kafka": { - "bindings": { - "kafka": { - "groupId": false - } - } - } - }, - "messageTraits": { - "commonHeaders": { - "headers": { - "type": "object", - "properties": { - "my-app-header": { - "type": "integer", - "minimum": 0, - "maximum": 100 - } - } - } - } - }, - "tags": { - "user": { - "name": "user", - "description": "User-related messages" - } - }, - "externalDocs": { - "infoDocs": { - "url": "https://example.com/docs", - "description": "Find more info here" - } - }, - "serverBindings": { - "devAmqp": { - "amqp": { - "exchange": "my-exchange", - "queue": "my-queue" - } - } - }, - "channelBindings": { - "user": { - "amqp": { - "is": "queue", - "queue": { - "exclusive": true - } - } - } - }, - "operationBindings": { - "sendUser": { - "amqp": { - "ack": false - } - } - }, - "messageBindings": { - "user": { - "amqp": { - "contentEncoding": "gzip", - "messageType": "user.signup", - "bindingVersion": "0.3.0" - } - } - } - } -} \ No newline at end of file diff --git a/spec/asyncapi.md b/spec/asyncapi.md index f4747096..b4282f50 100644 --- a/spec/asyncapi.md +++ b/spec/asyncapi.md @@ -273,6 +273,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Info Object Example + ```json { @@ -301,6 +302,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml title: AsyncAPI Sample App @@ -335,6 +337,7 @@ Field Name | Type | Description This object MAY be extended with [Specification Extensions](#specificationExtensions). + ```json { @@ -344,6 +347,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml name: API Support @@ -366,6 +370,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### License Object Example + ```json { @@ -374,6 +379,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml name: Apache 2.0 @@ -392,6 +398,7 @@ Field Pattern | Type | Description ##### Servers Object Example + ```json { @@ -434,6 +441,7 @@ Field Pattern | Type | Description } ``` + ```yaml development: @@ -487,6 +495,7 @@ Field Name | Type | Description A single server would be described as: + ```json { @@ -497,6 +506,7 @@ A single server would be described as: } ``` + ```yaml host: kafka.in.mycompany.com:9092 @@ -507,6 +517,7 @@ protocolVersion: '3.2' An example of a server that has a `pathname`: + ```json { @@ -517,6 +528,7 @@ An example of a server that has a `pathname`: } ``` + ```yaml host: rabbitmq.in.mycompany.com:5672 @@ -542,6 +554,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Server Variable Object Example + ```json { @@ -561,6 +574,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml host: 'rabbitmq.in.mycompany.com:5672' @@ -583,6 +597,7 @@ In case a message can't be encoded/decoded using this value, schema parsers MUST ##### Default Content Type Example + ```json { @@ -590,6 +605,7 @@ In case a message can't be encoded/decoded using this value, schema parsers MUST } ``` + ```yaml defaultContentType: application/json @@ -607,6 +623,7 @@ Field Pattern | Type | Description ##### Channels Object Example + ```json { @@ -621,6 +638,7 @@ Field Pattern | Type | Description } ``` + ```yaml userSignedUp: @@ -653,6 +671,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Channel Object Example + ```json { @@ -695,6 +714,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml address: 'users.{userId}' @@ -742,6 +762,7 @@ Field Pattern | Type | Description ##### Messages Object Example + ```json { @@ -754,6 +775,7 @@ Field Pattern | Type | Description } ``` + ```yaml userSignedUp: @@ -776,6 +798,7 @@ Field Pattern | Type | Description ##### Operations Object Example + ```json { @@ -804,6 +827,7 @@ Field Pattern | Type | Description } ``` + ```yaml onUserSignUp: @@ -849,6 +873,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Operation Object Example + ```json { @@ -874,6 +899,19 @@ This object MAY be extended with [Specification Extensions](#specificationExtens "scopes": [ "subscribe:auth_revocations" ], + "type": "oauth2", + "description": "The oauth security descriptions", + "flows": { + "clientCredentials": { + "tokenUrl": "https://example.com/api/oauth/dialog", + "availableScopes": { + "subscribe:auth_revocations": "Scope required for authorization revocation topic" + } + } + }, + "scopes": [ + "subscribe:auth_revocations" + ], "petstore_auth": [ "write:pets", "read:pets" @@ -895,6 +933,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ], "messages": [ { "$ref": "#/channels/userSignup/messages/userSignedUp" } + { "$ref": "#/channels/userSignup/messages/userSignedUp" } ], "reply": { "address": { @@ -905,11 +944,13 @@ This object MAY be extended with [Specification Extensions](#specificationExtens }, "messages": [ { "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" } + { "$ref": "#/channels/userSignupReply/messages/userSignedUpReply" } ] } } ``` + ```yaml title: User sign up @@ -931,6 +972,18 @@ security: petstore_auth: - 'write:pets' - 'read:pets' + - type: oauth2 + description: The oauth security descriptions + flows: + clientCredentials: + tokenUrl: 'https://example.com/api/oauth/dialog' + availableScopes: + 'subscribe:auth_revocations': Scope required for authorization revocation topic + scopes: + - 'subscribe:auth_revocations' + petstore_auth: + - 'write:pets' + - 'read:pets' tags: - name: user - name: signup @@ -940,8 +993,10 @@ bindings: ack: false traits: - $ref: '#/components/operationTraits/kafka' + - $ref: '#/components/operationTraits/kafka' messages: - $ref: '#/channels/userSignup/messages/userSignedUp' + - $ref: '#/channels/userSignup/messages/userSignedUp' reply: address: location: '$message.header#/replyTo' @@ -949,6 +1004,7 @@ reply: $ref: '#/channels/userSignupReply' messages: - $ref: '#/channels/userSignupReply/messages/userSignedUpReply' + - $ref: '#/channels/userSignupReply/messages/userSignedUpReply' ``` #### Operation Trait Object @@ -973,6 +1029,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Operation Trait Object Example + ```json { @@ -984,6 +1041,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml bindings: @@ -1022,6 +1080,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Examples + ```json { @@ -1030,6 +1089,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml description: Consumer Inbox @@ -1050,6 +1110,7 @@ Field Pattern | Type | Description ##### Parameters Object Example + ```json { @@ -1062,6 +1123,7 @@ Field Pattern | Type | Description } ``` + ```yaml address: user/{userId}/signedup @@ -1088,6 +1150,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Parameter Object Example + ```json { @@ -1101,6 +1164,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml address: user/{userId}/signedup @@ -1256,6 +1320,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Message Object Example + ```json { @@ -1321,6 +1386,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml name: UserSignup @@ -1368,6 +1434,7 @@ examples: Example using Avro to define the payload: + ```json { @@ -1389,6 +1456,7 @@ Example using Avro to define the payload: } ``` + ```yaml name: UserSignup @@ -1431,6 +1499,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Message Trait Object Example + ```json { @@ -1438,6 +1507,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml contentType: application/json @@ -1460,6 +1530,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Message Example Object Example + ```json { @@ -1480,6 +1551,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml name: SimpleSignup @@ -1514,6 +1586,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Tag Object Example + ```json { @@ -1522,6 +1595,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml name: user @@ -1543,6 +1617,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### External Documentation Object Example + ```json { @@ -1551,6 +1626,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml description: Find more info here @@ -1575,6 +1651,7 @@ This object cannot be extended with additional properties and any properties add ##### Reference Object Example + ```json { @@ -1582,6 +1659,7 @@ This object cannot be extended with additional properties and any properties add } ``` + ```yaml $ref: '#/components/schemas/Pet' @@ -1632,6 +1710,7 @@ my.org.User ##### Components Object Example + ```json { @@ -1766,6 +1845,7 @@ my.org.User } ``` + ```yaml components: @@ -1888,6 +1968,7 @@ Name | Allowed values | Notes ###### Multi Format Schema Object Example with Avro + ```yaml channels: @@ -1994,6 +2075,7 @@ As such, inline schema definitions, which do not have a given id, _cannot_ be us ###### Primitive Sample + ```json { @@ -2002,6 +2084,7 @@ As such, inline schema definitions, which do not have a given id, _cannot_ be us } ``` + ```yaml type: string @@ -2010,6 +2093,7 @@ format: email ###### Simple Model + ```json { @@ -2033,6 +2117,7 @@ format: email } ``` + ```yaml type: object @@ -2053,6 +2138,7 @@ properties: For a simple string to string mapping: + ```json { @@ -2063,6 +2149,7 @@ For a simple string to string mapping: } ``` + ```yaml type: object @@ -2072,6 +2159,7 @@ additionalProperties: For a string to model mapping: + ```json { @@ -2082,6 +2170,7 @@ For a string to model mapping: } ``` + ```yaml type: object @@ -2091,6 +2180,7 @@ additionalProperties: ###### Model with Example + ```json { @@ -2116,6 +2206,7 @@ additionalProperties: } ``` + ```yaml type: object @@ -2134,6 +2225,7 @@ examples: ###### Model with Boolean Schemas + ```json { @@ -2148,6 +2240,7 @@ examples: } ``` + ```yaml type: object @@ -2160,6 +2253,7 @@ properties: ###### Models with Composition + ```json { @@ -2203,6 +2297,7 @@ properties: } ``` + ```yaml schemas: @@ -2231,6 +2326,7 @@ schemas: ###### Models with Polymorphism Support + ```json { @@ -2325,6 +2421,7 @@ schemas: } ``` + ```yaml schemas: @@ -2533,6 +2630,7 @@ bearerFormat: JWT ###### Implicit OAuth2 Sample + ```json { @@ -2552,6 +2650,7 @@ bearerFormat: JWT } ``` + ```yaml type: oauth2 @@ -2648,6 +2747,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens ##### Examples + ```json { @@ -2656,6 +2756,7 @@ This object MAY be extended with [Specification Extensions](#specificationExtens } ``` + ```yaml description: Default Correlation ID