Skip to content

Commit

Permalink
autogen(docs): generate and format documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@aeneasr
aeneasr committed Apr 5, 2021
1 parent 380fc94 commit 7ba4b47
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
13 changes: 5 additions & 8 deletions docs/docs/reference/api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8005,7 +8005,6 @@ _NullTime implements sql.NullTime functionality._
}
],
"Interface": {
"ProtocolScheme": "string",
"Socket": "string",
"Types": [
{
Expand Down Expand Up @@ -8113,7 +8112,6 @@ _PluginConfigArgs plugin config args_

```json
{
"ProtocolScheme": "string",
"Socket": "string",
"Types": [
{
Expand All @@ -8129,11 +8127,10 @@ _PluginConfigInterface The interface between Docker and the plugin_

#### Properties

| Name | Type | Required | Restrictions | Description |
| -------------- | --------------------------------------------------- | -------- | ------------ | ----------------------------------------------------- |
| ProtocolScheme | string | false | none | Protocol to use for clients connecting to the plugin. |
| Socket | string | true | none | socket |
| Types | [[PluginInterfaceType](#schemaplugininterfacetype)] | true | none | types |
| Name | Type | Required | Restrictions | Description |
| ------ | --------------------------------------------------- | -------- | ------------ | ----------- |
| Socket | string | true | none | socket |
| Types | [[PluginInterfaceType](#schemaplugininterfacetype)] | true | none | types |

<a id="tocSpluginconfiglinux"></a>

Expand Down Expand Up @@ -8531,7 +8528,7 @@ _Volume volume_
| Name | string | true | none | Name of the volume. |
| Options | object | true | none | The driver specific options used when creating the volume. |
| » **additionalProperties** | string | false | none | none |
| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level. |
| Scope | string | true | none | The level at which the volume exists. Either `global` for cluster-wide,<br/>or `local` for machine level. |
| Status | object | false | none | Low-level details about the volume, provided by the volume driver.<br/>Details are returned as a map with key/value pairs:<br/>`{"key":"value","key2":"value2"}`.<br/><br/>The `Status` field is optional, and is omitted if the volume driver<br/>does not support this feature. |
| UsageData | [VolumeUsageData](#schemavolumeusagedata) | false | none | VolumeUsageData Usage details about the volume. This information is used by the<br/>`GET /system/df` endpoint, and omitted in other endpoints. |

Expand Down
6 changes: 1 addition & 5 deletions spec/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2105,10 +2105,6 @@
"Types"
],
"properties": {
"ProtocolScheme": {
"description": "Protocol to use for clients connecting to the plugin.",
"type": "string"
},
"Socket": {
"description": "socket",
"type": "string"
Expand Down Expand Up @@ -2451,7 +2447,7 @@
}
},
"Scope": {
"description": "The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.",
"description": "The level at which the volume exists. Either `global` for cluster-wide,\nor `local` for machine level.",
"type": "string"
},
"Status": {
Expand Down

0 comments on commit 7ba4b47

Please sign in to comment.