diff --git a/docs/API.md b/docs/API.md index d5cbf0e19..25d955432 100644 --- a/docs/API.md +++ b/docs/API.md @@ -1,18 +1,27 @@ ### Root - AsyncAPIDocument +- `AsyncAPIDocument.applicationPublishableChannels()` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.applicationPublishableMessages()` : Message[] +- `AsyncAPIDocument.applicationPublishOperations()` : Operation[] +- `AsyncAPIDocument.applicationSubscribableChannels()` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.applicationSubscribableMessages()` : Message[] +- `AsyncAPIDocument.applicationSubscribeOperations()` : Operation[] +- `AsyncAPIDocument.clientPublishableChannels()` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.clientPublishableMessages()` : Message[] +- `AsyncAPIDocument.clientPublishOperations()` : Operation[] +- `AsyncAPIDocument.clientSubscribableChannels()` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.clientSubscribableMessages()` : Message[] +- `AsyncAPIDocument.clientSubscribeOperations()` : Operation[] +- `AsyncAPIDocument.messages([])` : Message[] (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.channels([])` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.operations([])` : Operation[] - `AsyncAPIDocument.hasContentType('')` : boolean (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319)) -- `AsyncAPIDocument.channels()` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) -- **(HELP NEEDED)** `AsyncAPIDocument.channelsSubscribes('')` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) -- **(HELP NEEDED)** `AsyncAPIDocument.channelsPublishes('')` : Channel[] (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) -- **(HELP NEEDED)** `AsyncAPIDocument.isSubscribingToChannels('')` : boolean (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319)) -- **(HELP NEEDED)** `AsyncAPIDocument.isPublishingToChannels('')` : boolean (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319)) -- `AsyncAPIDocument.messages()` : Message[] (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) - `AsyncAPIDocument.schemas()` : Schema[] (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) - `AsyncAPIDocument.servers()` : Server[] (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) - `AsyncAPIDocument.server('')` : Server (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) +- `AsyncAPIDocument.info()` : Info - `AsyncAPIDocument.json()` : string (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961), [800963792](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800963792)) - `AsyncAPIDocument.securitySchemes()` : SecurityScheme[] (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) - ### Info - `Info.title()` : string (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596), [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407), [800963792](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800963792)) - `Info.description()` : string (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596), [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) @@ -25,26 +34,27 @@ ### SecurityScheme Empty for now. +### Operation +- `Operation.id()` : string +- `Operation.summary()` : string +- `Operation.messages()` : Message[] +- `Operation.channels()` : Channel[] +- `Operation.extension('')` : any +- `Operation.binding('', '')` : any + ### Channel - `Channel.path()` : string - `Channel.messages()` : Message[] -- **(HELP NEEDED)** `Channel.messagesPublishes('')` : Message[] -- **(HELP NEEDED)** `Channel.messagesSubscribes('')` : Message[] -- `Channel.isSubscribing('')` : boolean (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) -- `Channel.isPublishing('')` : boolean (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) +- `Channel.operations()` : Operation[] - `Channel.description()` : string (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) - `Channel.extension('')` : any (outcome of comment(s): [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) -- **(HELP NEEDED)** `Channel.extensionForPublishing('', '')` : any (outcome of comment(s): [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) -- **(HELP NEEDED)** `Channel.extensionForSubscribing('', '')` : any (outcome of comment(s): [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) - `Channel.binding('', '')` : any (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) -- **(HELP NEEDED)** `Channel.bindingForSubscribing('', '', '')` : any (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) -- **(HELP NEEDED)** `Channel.bindingForPublishing('', ', '')` : any (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) -- **(HELP NEEDED)** `Channel.summaryForPublishing('')` : string (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) -- **(HELP NEEDED)** `Channel.summaryForSubscribing('')` : string (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) - `Channel.parameters()` : Schema[] (outcome of comment(s): [800935961](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800935961)) -- **(HELP NEEDED)** `Channel.operationIdForPublishing('')` : string (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) -- **(HELP NEEDED)** `Channel.operationIdForSubscribing('')` : string (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) ### Message - `Message.headers()` : Schema (outcome of comment(s): [800282407](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-800282407)) -- `Message.payload()` : Schema (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) \ No newline at end of file +- `Message.payload()` : Schema (outcome of comment(s): [799481319](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799481319), [799598596](https://github.com/asyncapi/shape-up-process/issues/84#issuecomment-799598596)) +- `Message.channels()` : Channel[] +- `Message.operations()` : Operation[] +- `Message.extension('')` : any +- `Message.binding('', '')` : any \ No newline at end of file