From f31ff2a5144a4ee9322810ba3a690c2e207d7f0b Mon Sep 17 00:00:00 2001 From: Animesh Kumar Date: Tue, 2 Jul 2024 20:30:05 +0530 Subject: [PATCH] fix: delete temporary files Changes: - deleted temporary files which were added to see the changes happening when the files were being constructed - remove example markdown file which simulated the spec doc for testing purposes - applied suggestions from: https://github.com/asyncapi/spec/pull/1059#discussion_r1662025750 --- scripts/validation/ex-doc-v1.md | 42 - .../Channel-Object-json-format.json | 692 ---------------- .../Channel-Object-yaml-format.json | 692 ---------------- .../Channel-Parameter-Object-json-format.json | 691 ---------------- .../Channel-Parameter-Object-yaml-format.json | 691 ---------------- ...Channel-Parameters-Object-json-format.json | 690 ---------------- ...Channel-Parameters-Object-yaml-format.json | 690 ---------------- .../Channels-Object-json-format.json | 697 ---------------- .../Channels-Object-yaml-format.json | 697 ---------------- .../Components-Object-json-format.json | 750 ----------------- .../Components-Object-yaml-format.json | 750 ----------------- .../Contact-Object-json-format.json | 694 ---------------- .../Contact-Object-yaml-format.json | 694 ---------------- ...-Content-Type-at-root-doc-json-format.json | 690 ---------------- ...-Content-Type-at-root-doc-yaml-format.json | 690 ---------------- .../External-Docs-Object-json-format.json | 689 ---------------- .../External-Docs-Object-yaml-format.json | 689 ---------------- .../updated-docs/Info-Object-json-format.json | 694 ---------------- .../updated-docs/Info-Object-yaml-format.json | 694 ---------------- .../License-Object-json-format.json | 689 ---------------- .../License-Object-yaml-format.json | 689 ---------------- ...age-Correlation-ID-Object-json-format.json | 689 ---------------- ...age-Correlation-ID-Object-yaml-format.json | 689 ---------------- .../Message-Example-Object-json-format.json | 706 ---------------- .../Message-Example-Object-yaml-format.json | 706 ---------------- .../Message-Object-json-format.json | 693 ---------------- .../Message-Object-yaml-format.json | 693 ---------------- .../Message-Trait-Object-json-format.json | 690 ---------------- .../Message-Trait-Object-yaml-format.json | 690 ---------------- .../Messages-Object-json-format.json | 689 ---------------- .../Messages-Object-yaml-format.json | 689 ---------------- ...rmat-Schema-Object---Avro-yaml-format.json | 714 ---------------- .../Operation-Object-json-format.json | 697 ---------------- .../Operation-Object-yaml-format.json | 697 ---------------- ...tion-Reply-Address-Object-json-format.json | 690 ---------------- ...tion-Reply-Address-Object-yaml-format.json | 690 ---------------- .../Operation-Traits-Object-json-format.json | 697 ---------------- .../Operation-Traits-Object-yaml-format.json | 697 ---------------- .../Operations-Object-json-format.json | 719 ---------------- .../Operations-Object-yaml-format.json | 719 ---------------- .../Reference-Object-json-format.json | 689 ---------------- .../Reference-Object-yaml-format.json | 689 ---------------- ...---Allowing-Complex-model-json-format.json | 695 ---------------- ...---Allowing-Complex-model-yaml-format.json | 695 ---------------- ...ct---Map-Dictionary-model-json-format.json | 695 ---------------- ...ct---Map-Dictionary-model-yaml-format.json | 695 ---------------- ...Schema-Object---Primitive-json-format.json | 693 ---------------- ...Schema-Object---Primitive-yaml-format.json | 693 ---------------- ...ema-Object---Simple-model-json-format.json | 708 ---------------- ...ema-Object---Simple-model-yaml-format.json | 708 ---------------- ...ject---With-boolean-model-json-format.json | 699 ---------------- ...ject---With-boolean-model-yaml-format.json | 699 ---------------- ...---With-composition-model-json-format.json | 728 ---------------- ...---With-composition-model-yaml-format.json | 728 ---------------- ...ect---With-examples-model-json-format.json | 710 ---------------- ...ect---With-examples-model-yaml-format.json | 710 ---------------- ...--With-polymorphism-model-json-format.json | 779 ------------------ ...--With-polymorphism-model-yaml-format.json | 779 ------------------ ...-Scheme-OAuth-Flow-Object-json-format.json | 692 ---------------- ...-Scheme-OAuth-Flow-Object-yaml-format.json | 692 ---------------- ...eme-Object---API-key-auth-json-format.json | 648 --------------- ...eme-Object---API-key-auth-yaml-format.json | 648 --------------- ...y-Scheme-Object---API-key-json-format.json | 649 --------------- ...y-Scheme-Object---API-key-yaml-format.json | 649 --------------- ...urity-Scheme-Object---JWT-json-format.json | 649 --------------- ...urity-Scheme-Object---JWT-yaml-format.json | 649 --------------- ...rity-Scheme-Object---SASL-json-format.json | 647 --------------- ...rity-Scheme-Object---SASL-yaml-format.json | 647 --------------- ...rity-Scheme-Object---X509-json-format.json | 647 --------------- ...rity-Scheme-Object---X509-yaml-format.json | 647 --------------- ...ity-Scheme-Object---basic-json-format.json | 648 --------------- ...ity-Scheme-Object---basic-yaml-format.json | 648 --------------- ...t---end-to-end-encryption-json-format.json | 647 --------------- ...t---end-to-end-encryption-yaml-format.json | 647 --------------- ...Object---implicity-OAuth2-json-format.json | 659 --------------- ...Object---implicity-OAuth2-yaml-format.json | 659 --------------- ...Scheme-Object---user-pass-json-format.json | 647 --------------- ...Scheme-Object---user-pass-yaml-format.json | 647 --------------- .../Server-Object-json-format.json | 689 ---------------- ...ject-with-Variable-Object-json-format.json | 698 ---------------- ...ject-with-Variable-Object-yaml-format.json | 698 ---------------- ...rver-Object-with-pathname-json-format.json | 689 ---------------- ...rver-Object-with-pathname-yaml-format.json | 689 ---------------- .../Server-Object-yaml-format.json | 689 ---------------- .../Servers-Object-json-format.json | 701 ---------------- .../Servers-Object-yaml-format.json | 701 ---------------- .../updated-docs/Tag-Object-json-format.json | 689 ---------------- .../updated-docs/Tag-Object-yaml-format.json | 689 ---------------- 88 files changed, 60038 deletions(-) delete mode 100644 scripts/validation/ex-doc-v1.md delete mode 100644 scripts/validation/updated-docs/Channel-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Channel-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Channel-Parameter-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Channel-Parameter-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Channel-Parameters-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Channel-Parameters-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Channels-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Channels-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Components-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Components-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Contact-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Contact-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Default-Content-Type-at-root-doc-json-format.json delete mode 100644 scripts/validation/updated-docs/Default-Content-Type-at-root-doc-yaml-format.json delete mode 100644 scripts/validation/updated-docs/External-Docs-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/External-Docs-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Info-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Info-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/License-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/License-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Message-Correlation-ID-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Message-Correlation-ID-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Message-Example-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Message-Example-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Message-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Message-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Message-Trait-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Message-Trait-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Messages-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Messages-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Muti-Format-Schema-Object---Avro-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Operation-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Operation-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Operation-Reply-Address-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Operation-Reply-Address-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Operation-Traits-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Operation-Traits-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Operations-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Operations-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Reference-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Reference-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Allowing-Complex-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Map-Dictionary-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Primitive-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Primitive-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Simple-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---Simple-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-boolean-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-boolean-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-composition-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-composition-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-examples-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-examples-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-json-format.json delete mode 100644 scripts/validation/updated-docs/Schema-Object---With-polymorphism-model-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-OAuth-Flow-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---API-key-auth-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---API-key-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---API-key-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---JWT-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---JWT-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---SASL-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---SASL-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---X509-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---X509-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---basic-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---basic-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---end-to-end-encryption-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---implicity-OAuth2-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---user-pass-json-format.json delete mode 100644 scripts/validation/updated-docs/Security-Scheme-Object---user-pass-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Server-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Server-Object-with-Variable-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Server-Object-with-Variable-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Server-Object-with-pathname-json-format.json delete mode 100644 scripts/validation/updated-docs/Server-Object-with-pathname-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Server-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Servers-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Servers-Object-yaml-format.json delete mode 100644 scripts/validation/updated-docs/Tag-Object-json-format.json delete mode 100644 scripts/validation/updated-docs/Tag-Object-yaml-format.json 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