Descriptions and Maintainers added to Event Sources

This new release brings us a couple of small features:

• The ability to add descriptions for your event sources
• The ability to add maintainers (list of names/teams) to each source.

Thanks to @SeanAlexanderHarris for raising the issue #9.

Why

This feature is another way you can help give extra context to team members about why your event sources may exist and their boundaries within your system. Some larger organisations also split domains by source, so you may have different people/teams managing the sources, you can now define who owns them and maintains them.

How to get started

When you run npm run generate-eventmetadata this will populate your /data folder with all your events.

Generate metadata will now also put a new file in your source directorys called source-metadata.json. This file will contain the description and maintainers. Running npm run generate-eventmetadata will populate a template for you.

Example

{
  "description": "Here is a description of my source",
  "maintainers": ["David Boyne"]
}

File can be found in /data/{source}/source-metadata.json.

If you don't wish to run the generate script again you can simply just add the source-metadata.json file in the correct location.

Everything here is optional, and the application will continue to work even if you don't have any source-metadta files.

Small fix with Region not being used

EventBridge Atlas was not using the REGION set in the .env file.

The REGION is now read and used when getting schemas and using eventbridge SDK.

Thanks to @bls20AWS for spotting this one.

1.0.0 - Auto populate metadata, refactors and fixes

Happy to share with you all that 1.0.0 is now out

Breaking Changes

• The way event-metadata is stored and populated has changed, hopefully making it easier for people to get started. Rather than having an data/event-metadata.json file you can now run npm run generate-eventmetadata which will populate your data directory with all the event meta data you need.

Features

Event Metadata in seconds

EventBridge Atlas will display your Schemas and Events for you, but requires you to fill in any descriptions or examples yourself. This used to quite a manual process, but now EventBridge Atlas has made this easier for you.

When you clone the project run npm run generate-eventmetadata which will populate your event metata data for you.

Here is an example of the output

/data/my-event-source/MyEvent.json

{
    "description": "My Event is raised when our system does something interested. Change this to what you want.",
    "detail": {
        "brand": {
            "code": {
                "type": "string",
                "description": "The brand of the user", // Fill out the details for each description. The template is made for you
                "example": ""
            }
        },
        "data": {
            "applicationProductIds": {
                "type": "array",
                "description": "",
                "example": ""
            },
            "decision": {
                "type": "string",
                "description": "",
                "example": ""
            },
            "decision_at": {
                "type": "string",
                "description": "",
                "example": ""
            },
            "status": {
                "type": "string",
                "description": "",
                "example": ""
            }
        },
        "metadata": {
            "correlationId": {
                "type": "string",
                "description": "",
                "example": ""
            },
            "service": {
                "type": "string",
                "description": "",
                "example": ""
            }
        },
        "user": {
            "id": {
                "type": "number",
                "description": "",
                "example": ""
            }
        }
    },
    "example": { // This example is prepopulated for you. Just change the defaults.
        "detail-type": "MyEvent",
        "resources": [],
        "detail": {
            "metadata": {
                "service": "ut",
                "correlationId": "sed eiusmod"
            },
            "data": {
                "decision": "sit deserunt officia incididunt sint",
                "decision_at": "1999-04-13T23:00:00.0Z",
                "brand": {
                    "code": "magna deserunt ex sit exercitation"
                },
                "user": {
                    "id": 1
                },
                "applicationProductIds": [1, 2, 3],
                "status": "active"
            }
        },
        "id": "29a3717a-3304-423e-9595-46c020ab33d8",
        "source": "deadhappy.claims",
        "time": "2021-07-13T06:51:53.741Z",
        "region": "eu-west-1",
        "version": "4",
        "account": "YOUR_ACCOUNT"
    }
}

The descriptions and examples will now be shown when you generate your docs.

Refacators & Fixes

• The parsers now use the Registry and Schema models.
• Simplified the parsers for Docuowl and Slate.

Fix bug with Flow parser

Fix

• Fixed issue with flow parser, now has relevant folders required to write to disk.

New Flow (Node) Diagram support!

New Features

• New Parser created to create flow (node) diagrams for your eventbridge schemas!

Added new parser for slate

Happy to announce we now support Slate format!

New Features

• Started to move towards models to help with AWS Schemas and Events (still need to move old parsers to it)
• New support for Slate
• Updates to UI for landing page

Moving to Parser architecture & support for AsyncAPI

Happy to announce we now support AsyncAPI format!

New Features

• Architecture now support parsers.
• New support for AsyncAPI
• No longer using AWS CLI and moved to v3 of AWS SDK (thanks @amancevice and @heitorlessa)

Other minor changes

• Update to documentation to support parsers and new ways of working

Initial Release of EventBridge Atlas

First release of EventBridge Atlas

• Support docuowl output
• uses aws cli to get schemas and data
• outputs HTML