You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/resources/api.md
+12-21Lines changed: 12 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,39 +47,30 @@ Defaults to `slugify(name + version)`
47
47
48
48
### Read-Only
49
49
50
-
-`api_spec_ids` (List of String) The list of API specification ids for the API.
51
-
-`auth_strategy_sync_error` (Attributes) (see [below for nested schema](#nestedatt--auth_strategy_sync_error))
50
+
-`api_spec_ids` (List of String, Deprecated) The list of API specification ids for the API.
52
51
-`created_at` (String) An ISO-8601 timestamp representation of entity creation date.
52
+
-`current_version_summary` (Attributes) (see [below for nested schema](#nestedatt--current_version_summary))
53
53
-`id` (String) The API identifier.
54
54
-`portals` (Attributes List) The list of portals which this API is published to. (see [below for nested schema](#nestedatt--portals))
55
55
-`updated_at` (String) An ISO-8601 timestamp representation of entity update date.
56
56
57
-
<aid="nestedatt--auth_strategy_sync_error"></a>
58
-
### Nested Schema for `auth_strategy_sync_error`
57
+
<aid="nestedatt--current_version_summary"></a>
58
+
### Nested Schema for `current_version_summary`
59
59
60
60
Read-Only:
61
61
62
-
-`control_plane_error` (String) must be one of ["control_plane_error_no_response", "control_plane_error_invalid_response", "control_plane_error_unavailable", "control_plane_error_internal_error", "control_plane_error_bad_request", "control_plane_error_plugin_conflict", "control_plane_error_data_constraint_error", "control_plane_error_implementation_not_found"]
63
-
-`info` (Attributes) (see [below for nested schema](#nestedatt--auth_strategy_sync_error--info))
### Nested Schema for `current_version_summary.spec`
76
70
77
71
Read-Only:
78
72
79
-
-`additional_properties` (String) Parsed as JSON.
80
-
-`message` (List of String)
81
-
-`type` (String)
82
-
73
+
-`type` (String) The type of specification being stored. This allows us to render the specification correctly. must be one of ["oas2", "oas3", "asyncapi"]
-`api_id` (String) The UUID API identifier. Requires replacement if changed.
32
+
33
+
### Optional
34
+
32
35
-`service` (Attributes) A Gateway service that implements an API. Requires replacement if changed. (see [below for nested schema](#nestedatt--service))
### Nested Schema for `service.auth_strategy_sync_error`
57
+
58
+
Read-Only:
59
+
60
+
-`control_plane_error` (String) must be one of ["control_plane_error_no_response", "control_plane_error_invalid_response", "control_plane_error_unavailable", "control_plane_error_internal_error", "control_plane_error_bad_request", "control_plane_error_plugin_conflict", "control_plane_error_data_constraint_error", "control_plane_error_implementation_not_found"]
61
+
-`info` (Attributes) (see [below for nested schema](#nestedatt--service--auth_strategy_sync_error--info))
-`type` (String) The type of specification being stored. This allows us to render the specification correctly. must be one of ["oas2", "oas3", "asyncapi"]; Requires replacement if changed.
34
+
-`type` (String) The type of specification being stored. This allows us to render the specification correctly. must be one of ["oas2", "oas3", "asyncapi"]
0 commit comments