api-responses-document/custom-elements.json at master · advanced-rest-client/api-responses-document · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
{
  "version": "experimental",
  "tags": [
    {
      "name": "api-links-document",
      "path": "./api-links-document.js",
      "properties": [
        {
          "name": "styles",
          "type": "CSSResult"
        },
        {
          "name": "links",
          "type": "array"
        },
        {
          "name": "ns",
          "description": "A namespace for AMF model.",
          "type": "Namespace"
        },
        {
          "name": "amf",
          "description": "Generated AMF json/ld model form the API spec.\nThe element assumes the object of the first array item to be a\ntype of `\"http://raml.org/vocabularies/document#Document`\non AMF vocabulary.\n\nIt is only useful for the element to resolve references.",
          "type": "object | object[] | undefined"
        }
      ]
    },
    {
      "name": "api-responses-document",
      "path": "./api-responses-document.js",
      "description": "`api-responses-document`\n\nA documentation for method responses based on AMF model.\n\nIt renders a selector of available status codes in the responses array.\nThis is computed from `returns` property which must be an array\nas a value of AMF's `http://www.w3.org/ns/hydra/core#returns` property\nof the `method` shape.\n\nStatus codes are sorted before rendering.\n\nIn the documentation part it renders annotations (AMF custom properties)\nadded to the response, headers and body.",
      "attributes": [
        {
          "name": "selected",
          "description": "Selected index of a status code from the selector.",
          "type": "number"
        },
        {
          "name": "narrow",
          "description": "Set to render a mobile friendly view.",
          "type": "boolean"
        },
        {
          "name": "legacy",
          "type": "boolean",
          "deprecatedMessage": "Use `compatibility` instead."
        },
        {
          "name": "compatibility",
          "description": "Enables compatibility with Anypoint components.",
          "type": "boolean"
        },
        {
          "name": "graph",
          "description": "When enabled it renders external types as links and dispatches\n`api-navigation-selection-changed` when clicked.",
          "type": "boolean"
        }
      ],
      "properties": [
        {
          "name": "styles",
          "type": "CSSResult[]"
        },
        {
          "name": "returns",
          "description": "The `returns` property of the method AMF model.",
          "type": "array"
        },
        {
          "name": "selected",
          "attribute": "selected",
          "description": "Selected index of a status code from the selector.",
          "type": "number"
        },
        {
          "name": "narrow",
          "attribute": "narrow",
          "description": "Set to render a mobile friendly view.",
          "type": "boolean"
        },
        {
          "name": "legacy",
          "attribute": "legacy",
          "type": "boolean",
          "deprecatedMessage": "Use `compatibility` instead."
        },
        {
          "name": "compatibility",
          "attribute": "compatibility",
          "description": "Enables compatibility with Anypoint components.",
          "type": "boolean"
        },
        {
          "name": "graph",
          "attribute": "graph",
          "description": "When enabled it renders external types as links and dispatches\n`api-navigation-selection-changed` when clicked.",
          "type": "boolean"
        },
        {
          "name": "links",
          "description": "A computed list of OAS' Links in currently selected response.",
          "type": "any[] | undefined"
        },
        {
          "name": "codes",
          "description": "List of recognized codes.",
          "type": "string[] | undefined"
        },
        {
          "name": "hasPayload",
          "type": "boolean"
        },
        {
          "name": "hasHeaders",
          "type": "boolean"
        },
        {
          "name": "hasDescription",
          "type": "boolean"
        },
        {
          "name": "noDocumentation",
          "type": "boolean"
        },
        {
          "name": "ns",
          "description": "A namespace for AMF model.",
          "type": "Namespace"
        },
        {
          "name": "amf",
          "description": "Generated AMF json/ld model form the API spec.\nThe element assumes the object of the first array item to be a\ntype of `\"http://raml.org/vocabularies/document#Document`\non AMF vocabulary.\n\nIt is only useful for the element to resolve references.",
          "type": "object | object[] | undefined"
        }
      ]
    }
  ]
}