Showing results for 
Search instead for 
Did you mean: 
Sign up Log in

Earn badges and make progress

You're on your way to the next level! Join the Kudos program to earn points and save your progress.

Deleted user Avatar
Deleted user

Level 1: Seed

25 / 150 points

Next: Root


1 badge earned


Participate in fun challenges

Challenges come and go, but your rewards stay with you. Do more to earn more!


Gift kudos to your peers

What goes around comes around! Share the love by gifting kudos to your peers.


Rise up in the ranks

Keep earning points to reach the top of the leaderboard. It resets every quarter so you always have a chance!


Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
Community Members
Community Events
Community Groups

Usable Compass.yml JSON schema

Christopher Stolk
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
Apr 03, 2023

Hi there! I've started discovery on Compass as a tool to catalogue our software landscape. So far I'm impressed by its features, however the lack of a publicly accessible schema for the compass.yml file makes documenting through code a less than viable option.

However! Instead of coming here to complain I figured I might as well create a rough draft of the schema myself and share it here! It has been a while since I've had to create a schema myself, so any suggestions and/or improvements are welcome.

The schema currently supports:

  • All inputs defined in the documentation
  • Validation for enum-esque inputs
    • component types
    • lifecycle stages
    • link types
    • custom field types (only the type itself, not the actual value)
  • Validation of typeId in conjunction with the tier field (as described under the fields section in the docs)
  • Pattern validation for component and team ARI's

GitHub gist - Compass schema 

Raw schema (directly usable) 


1 comment

Josh Campbell
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
Apr 03, 2023

Wooo awesome! Really appreciate you going the extra mile here and sharing the gist, thank you! I'd like to turn this around quickly since you gave us a leg up, let me connect with the team and see if we can get this published with our dev docs. Cheers, awesome work Chris!

Like # people like this
Christopher Stolk
I'm New Here
I'm New Here
Those new to the Atlassian Community have posted less than three times. Give them a warm welcome!
Apr 04, 2023

Hi Josh, thanks for the kind words. It'd be great to see this published to to integrate this more easily in all sorts of tools. Feel free to use what I shared as a base (or directly share it)

Like Richard Simpson likes this

+1 to getting it in schemastore so VSCode can automatically pick this up


Log in or Sign up to comment
AUG Leaders

Atlassian Community Events