Connected Component

Type: object

AttributeTypeDescription
componentsObject Reference[]Components that are connected
file_pathstring (Optional)File path of the connected component from the source code
namestring (Optional)Name of the connected component
descriptionstring (Optional)Description of the connected component
codeCode (Optional)-
linksConnected Component Link[]Links of the connected component
sourceResource Source (Optional)-

Example

{
  "components": [
    {
      "id": "5dbad85a76ea51c1f35b6f69"
    }
  ],
  "name": "Button",
  "description": "Generic button for HAL 9000",
  "code": {
    "snippet": "<div>Hello World</div>",
    "language": "html"
  },
  "links": [
    {
      "type": "github",
      "url": "https://github.com/octocat/Hello-World/blob/master/README"
    },
    {
      "type": "custom",
      "name": "Confluence",
      "url": "https://example.atlassian.net/wiki/spaces/DS/pages"
    }
  ]
}