storj.io/minio@v0.0.0-20230509071714-0cbc90f649b1/cmd/config/api/help.go (about)

     1  /*
     2   * MinIO Cloud Storage, (C) 2020 MinIO, Inc.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package api
    18  
    19  import "storj.io/minio/cmd/config"
    20  
    21  // Help template for storageclass feature.
    22  var (
    23  	Help = config.HelpKVS{
    24  		config.HelpKV{
    25  			Key:         apiRequestsMax,
    26  			Description: `set the maximum number of concurrent requests, e.g. "1600"`,
    27  			Optional:    true,
    28  			Type:        "number",
    29  		},
    30  		config.HelpKV{
    31  			Key:         apiRequestsDeadline,
    32  			Description: `set the deadline for API requests waiting to be processed e.g. "1m"`,
    33  			Optional:    true,
    34  			Type:        "duration",
    35  		},
    36  		config.HelpKV{
    37  			Key:         apiCorsAllowOrigin,
    38  			Description: `set comma separated list of origins allowed for CORS requests e.g. "https://example1.com,https://example2.com"`,
    39  			Optional:    true,
    40  			Type:        "csv",
    41  		},
    42  		config.HelpKV{
    43  			Key:         apiRemoteTransportDeadline,
    44  			Description: `set the deadline for API requests on remote transports while proxying between federated instances e.g. "2h"`,
    45  			Optional:    true,
    46  			Type:        "duration",
    47  		},
    48  		config.HelpKV{
    49  			Key:         apiReplicationWorkers,
    50  			Description: `set the number of replication workers, defaults to 100`,
    51  			Optional:    true,
    52  			Type:        "number",
    53  		},
    54  	}
    55  )