{"id":16171872,"url":"https://github.com/fmvilas/topic-definition","last_synced_at":"2026-01-20T05:03:24.055Z","repository":{"id":44557607,"uuid":"88434124","full_name":"fmvilas/topic-definition","owner":"fmvilas","description":"AsyncAPI topic structure definition","archived":false,"fork":false,"pushed_at":"2017-10-30T14:13:05.000Z","size":10,"stargazers_count":61,"open_issues_count":0,"forks_count":10,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-07T07:56:21.004Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fmvilas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-16T18:25:29.000Z","updated_at":"2025-02-04T18:15:44.000Z","dependencies_parsed_at":"2022-09-13T15:31:19.209Z","dependency_job_id":null,"html_url":"https://github.com/fmvilas/topic-definition","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fmvilas/topic-definition","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmvilas%2Ftopic-definition","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmvilas%2Ftopic-definition/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmvilas%2Ftopic-definition/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmvilas%2Ftopic-definition/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fmvilas","download_url":"https://codeload.github.com/fmvilas/topic-definition/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fmvilas%2Ftopic-definition/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28596087,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T02:08:49.799Z","status":"ssl_error","status_checked_at":"2026-01-20T02:08:44.148Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-10T03:44:16.437Z","updated_at":"2026-01-20T05:03:24.031Z","avatar_url":"https://github.com/fmvilas.png","language":null,"readme":"# AsyncAPI Topic Definition\n\n## Introduction\n\nThe purpose of this document is to describe how an AsyncAPI topic should be structured. The goal is to create a definition that suites most use cases and establish the foundation for community tooling and better interoperability between products when using AsyncAPI.\n\n## What is a topic?\n\nA topic is a string representing where an AsyncAPI can publish or subscribe. For the sake of comparison they are like URLs in a REST API.\n\n## Components\n\nBelow we describe the components of an AsyncAPI topic.\n\n### Organization\n\nThe name of the organization or company.\n\n###### Example:\n\n**`hitch`**.`accounts`.`1`.`event`.`user`.`signedup`\n\n### Service/Team/Department\n\nThe service, team or department in charge of managing the message.\n\n###### Example:\n\n`hitch`.**`accounts`**.`1`.`event`.`user`.`signedup`\n\n### Message version\n\nThe version of the message for the given service. This version number should remain the same unless changes in the messages are NOT backward compatible.\n\n###### Example:\n\n`hitch`.`accounts`.**`1`**.`event`.`user`.`signedup`\n\n\u003e Note: This version number is NOT related to your service or program version.\n\n### Message type\n\nIt contains the type of the message, e.g., *is it a `command` or an `event`?*. This value should always be `event` unless you're trying to explicitly execute a command in another service, i.e., when using RPC.\n\n###### Example:\n\n`hitch`.`accounts`.`1`.**`event`**.`user`.`signedup`\n\n`hitch`.`email`.`1`.**`command`**.`user`.`welcome`.`send`\n\n### Resources and sub-resources\n\nA word (or words) describing the resource the message refers to. For instance, if you're sending a message to notify a user has just signed up, the resource should be `user`. But, if you want to send a message to notify a user has just changed her full name, you could name it as `user.full_name`.\n\n###### Example:\n\n`hitch`.`accounts`.`1`.`event`.**`user`**.`signedup`\n\n`hitch`.`email`.`1`.`command`.**`user`.`welcome`**.`send`\n\n### Event/Command name\n\nIn case message type is `event`, this should be a verb **in past tense** describing what happened to the resource.\n\nIn case message type is `command`, this should be a verb **in infinitive form** describing what operation you want to perform.\n\n###### Example:\n\n`hitch`.`accounts`.`1`.`event`.`user`.**`signedup`**\n\n`hitch`.`email`.`1`.`command`.`user`.`welcome`.**`send`**\n\n### Status (optional)\n\nA word describing the status of a previous **command**. When used, **the type of the topic MUST be `event`.** Allowed values are:\n\n- `queued`: The command has been queued.\n- `succeeded`: The command has been handled/executed successfully.\n- `failed`: The command has failed.\n- `done`: The command has finished.\n\n###### Examples:\n\n1. A user has just signed up:\n`hitch`.`accounts`.`1`.`event`.`user`.`signedup`\n\n2. We send a welcome email:\n`hitch`.`email`.`1`.`command`.`user`.`welcome`.`send`\n\n3. But the email gets queued, so the email service sends a message to:\n`hitch`.`email`.`1`.`event`.`user`.`welcome`.`send`.`queued`\n\n4. The email gets finally delivered and the email service sends messages to:\n   - `hitch`.`email`.`1`.`event`.`user`.`welcome`.`send`.`succeeded`\n   - `hitch`.`email`.`1`.`event`.`user`.`welcome`.`send`.`done`\n5. Or, the recipient doesn't exist, and the email service sends messages to:\n   - `hitch`.`email`.`1`.`event`.`user`.`welcome`.`send`.`failed`\n   - `hitch`.`email`.`1`.`event`.`user`.`welcome`.`send`.`done`\n6. The user sign up process has been completed so the accounts service sends:\n`hitch`.`accounts`.`1`.`event`.`user`.`signup`.`done`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmvilas%2Ftopic-definition","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffmvilas%2Ftopic-definition","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffmvilas%2Ftopic-definition/lists"}