Remove port :9000 for play.min.io (#130)

This commit is contained in:
Harshavardhana 2019-07-24 10:07:54 -07:00 committed by Aditya Manthramurthy
parent 0bcb1c9b33
commit 3291f8673c
18 changed files with 200 additions and 200 deletions

View File

@ -25,7 +25,7 @@ stack test
```
A section of the tests use the remote MinIO Play server at
`https://play.min.io:9000` by default. For library development,
`https://play.min.io` by default. For library development,
using this remote server maybe slow. To run the tests against a
locally running MinIO live server at `http://localhost:9000`, just set
the environment `MINIO_LOCAL` to any value (and unset it to switch
@ -47,7 +47,7 @@ stack haddock
-- stack --resolver lts-11.1 runghc --package minio-hs --package optparse-applicative --package filepath
--
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
-- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
@ -76,7 +76,7 @@ import UnliftIO (throwIO, try)
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -21,7 +21,7 @@ awsCI { connectAccesskey = "your-access-key"
```
| Bucket operations | Object Operations | Presigned Operations |
|:---|:---|:---|
|:--------------------------------------------------|:----------------------------------------------|:--------------------------------------------------|
| [`listBuckets`](#listBuckets) | [`getObject`](#getObject) | [`presignedGetObjectUrl`](#presignedGetObjectUrl) |
| [`makeBucket`](#makeBucket) | [`putObject`](#putObject) | [`presignedPutObjectUrl`](#presignedPutObjectUrl) |
| [`removeBucket`](#removeBucket) | [`fGetObject`](#fGetObject) | [`presignedPostPolicy`](#presignedPostPolicy) |
@ -70,7 +70,7 @@ enable/disable the automatic region discovery behaviour.
The parameters in the expression `awsWithRegion region autoDiscover` are:
| Parameter | Type | Description |
|:---|:---|:---|
|:---------------|:----------------------------|:---------------------------------------------------------------------------------------------------------------------------|
| `region` | _Region_ (alias for `Text`) | The region to connect to by default for all requests. |
| `autoDiscover` | _Bool_ | If `True`, region discovery will be enabled. If `False`, discovery is disabled, and all requests go the given region only. |
@ -78,7 +78,7 @@ The parameters in the expression `awsWithRegion region autoDiscover` are:
This constructor provides connection and authentication information to
connect to the public MinIO Play server at
`https://play.min.io:9000/`.
`https://play.min.io/`.
#### minioCI :: Text -> Int -> Bool -> ConnectInfo
@ -87,7 +87,7 @@ Use to connect to a MinIO server.
The parameters in the expression `minioCI host port isSecure` are:
| Parameter | Type | Description |
|:---|:---|:---|
|:-----------|:-------|:--------------------------------------------------------|
| `host` | _Text_ | Hostname of the MinIO or other S3-API compatible server |
| `port` | _Int_ | Port number to connect to |
| `isSecure` | _Bool_ | Does the server use HTTPS? |
@ -97,7 +97,7 @@ The parameters in the expression `minioCI host port isSecure` are:
The following table shows the fields in the `ConnectInfo` record-type:
| Field | Type | Description |
|:---|:---|:---|
|:----------------------------|:----------------------------|:--------------------------------------------------------------------------------------------------|
| `connectHost` | _Text_ | Host name of the server. Defaults to `localhost`. |
| `connectPort` | _Int_ | Port number on which the server listens. Defaults to `9000`. |
| `connectAccessKey` | _Text_ | Access key to use in authentication. Defaults to `minio`. |
@ -149,14 +149,14 @@ Lists buckets.
__Return Value__
| Return type | Description |
|:---|:---|
|:---------------------|:----------------|
| _Minio [BucketInfo]_ | List of buckets |
__BucketInfo record type__
| Field | Type | Description |
|:---|:---| :---|
|:-----------------|:---------------------------|:----------------------------|
| `biName` | _Bucket_ (alias of `Text`) | Name of the bucket |
| `biCreationDate` | _UTCTime_ | Creation time of the bucket |
@ -172,7 +172,7 @@ __Parameters__
In the expression `makeBucket bucketName region` the arguments are:
| Param | Type | Description |
|---|---|---|
|--------------|-----------------------------|-----------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `region` | _Maybe Region_ | Region where the bucket is to be created. If not specified, default to the region in `ConnectInfo`. |
@ -201,7 +201,7 @@ __Parameters__
In the expression `removeBucket bucketName` the arguments are:
| Param | Type | Description |
|---|---|---|
|--------------|-----------------------------|--------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
@ -234,7 +234,7 @@ In the expression `listObjects bucketName prefix recursive` the
arguments are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have |
| `recursive` | _Bool_ | `True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. |
@ -242,13 +242,13 @@ arguments are:
__Return Value__
| Return type | Description |
|:---|:---|
|:------------------------------------|:------------------------------------------------------------------------|
| _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. |
__ObjectInfo record type__
| Field | Type | Description |
|:---|:---| :---|
|:------------|:----------------------------|:---------------------------------|
| `oiObject` | _Object_ (alias for `Text`) | Name of object |
| `oiModTime` | _UTCTime_ | Last modified time of the object |
| `oiETag` | _ETag_ (alias for `Text`) | ETag of the object |
@ -265,7 +265,7 @@ import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
@ -295,7 +295,7 @@ In the expression `listObjectsV1 bucketName prefix recursive` the
arguments are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have |
| `recursive` | _Bool_ | `True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. |
@ -303,13 +303,13 @@ arguments are:
__Return Value__
| Return type | Description |
|:---|:---|
|:------------------------------------|:------------------------------------------------------------------------|
| _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. |
__ObjectInfo record type__
| Field | Type | Description |
|:---|:---| :---|
|:------------|:----------------------------|:---------------------------------|
| `oiObject` | _Object_ (alias for `Text`) | Name of object |
| `oiModTime` | _UTCTime_ | Last modified time of the object |
| `oiETag` | _ETag_ (alias for `Text`) | ETag of the object |
@ -326,7 +326,7 @@ import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
@ -355,7 +355,7 @@ In the expression `listIncompleteUploads bucketName prefix recursive`
the parameters are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have. |
| `recursive` | _Bool_ | `True` indicates recursive style listing and `Talse` indicates directory style listing delimited by '/'. |
@ -369,7 +369,7 @@ __Return Value__
__UploadInfo record type__
| Field | Type | Description |
|:---|:---| :---|
|:-------------|:---------|:------------------------------------------|
| `uiKey` | _Object_ | Name of incompletely uploaded object |
| `uiUploadId` | _String_ | Upload ID of incompletely uploaded object |
| `uiSize` | _Int64_ | Size of incompletely uploaded object |
@ -384,7 +384,7 @@ import Conduit
import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
@ -416,7 +416,7 @@ In the expression `getObject bucketName objectName opts` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:----------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range |
@ -424,7 +424,7 @@ are:
__GetObjectOptions record type__
| Field | Type | Description |
|:---|:---| :---|
|:-----------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------|
| `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object |
| `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match |
| `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match |
@ -436,7 +436,7 @@ __Return Value__
The return value can be incrementally read to process the contents of
the object.
| Return type | Description |
|:---|:---|
|:--------------------------------------------|:-----------------------------------------|
| _Minio (C.ConduitM () ByteString Minio ())_ | A Conduit source of `ByteString` values. |
__Example__
@ -451,7 +451,7 @@ import qualified Data.Conduit.Binary as CB
import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
@ -483,7 +483,7 @@ In the expression `putObject bucketName objectName inputSrc` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:------------------------------------|:------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputSrc` | _C.ConduitM () ByteString Minio ()_ | A Conduit producer of `ByteString` values |
@ -501,7 +501,7 @@ import qualified Data.Conduit.Combinators as CC
import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
@ -534,7 +534,7 @@ In the expression `fGetObject bucketName objectName inputFile` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:----------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputFile` | _FilePath_ | Path to the file to be uploaded |
@ -544,7 +544,7 @@ are:
__GetObjectOptions record type__
| Field | Type | Description |
|:---|:---| :---|
|:-----------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------|
| `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object |
| `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match |
| `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match |
@ -561,7 +561,7 @@ import Data.Conduit.Binary (sinkLbs)
import Prelude
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
@ -593,7 +593,7 @@ In the expression `fPutObject bucketName objectName inputFile` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:--------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputFile` | _FilePath_ | Path to the file to be uploaded |
@ -630,7 +630,7 @@ In the expression `copyObject dstInfo srcInfo` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:----------|:------------------|:----------------------------------------------------------|
| `dstInfo` | _DestinationInfo_ | A value representing properties of the destination object |
| `srcInfo` | _SourceInfo_ | A value representing properties of the source object |
@ -638,7 +638,7 @@ are:
__SourceInfo record type__
| Field | Type | Description |
|:---|:---| :---|
|:-----------------------|:-----------------------|:----------------------------------------------------------------------------------------------------------|
| `srcBucket` | `Bucket` | Name of source bucket |
| `srcObject` | `Object` | Name of source object |
| `srcRange` | `Maybe (Int64, Int64)` | (Optional) Represents the byte range of source object. (0, 9) represents first ten bytes of source object |
@ -650,7 +650,7 @@ __SourceInfo record type__
__Destination record type__
| Field | Type | Description |
|:---|:---| :---|
|:------------|:---------|:-----------------------------------------------------|
| `dstBucket` | `Bucket` | Name of destination bucket in server-side copyObject |
| `dstObject` | `Object` | Name of destination object in server-side copyObject |
@ -685,7 +685,7 @@ In the expression `removeObject bucketName objectName` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:-------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
@ -719,7 +719,7 @@ In the expression `removeIncompleteUpload bucketName objectName` the parameters
are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:-------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
@ -753,7 +753,7 @@ In the expression `selectObjectContent bucketName objectName selReq`
the parameters are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:--------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `selReq` | _SelectRequest_ | Select request parameters |
@ -805,7 +805,7 @@ __Parameters__
In the expression `bucketExists bucketName` the parameters are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:----------------------------|:-------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
@ -829,7 +829,7 @@ In the expression `presignedGetObjectUrl bucketName objectName expiry queryParam
the parameters are:
| Param | Type | Description |
|:---|:---| :---|
|:--------------|:---------------------------------------------------------------|:------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds |
@ -842,7 +842,7 @@ Returns the generated URL - it will include authentication
information.
| Return type | Description |
|:---|:---|
|:-------------|:------------------------|
| _ByteString_ | Generated presigned URL |
__Example__
@ -887,7 +887,7 @@ In the expression `presignedPutObjectUrl bucketName objectName expiry headers`
the parameters are:
| Param | Type | Description |
|:---|:---| :---|
|:-------------|:---------------------------------------------------------------|:------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds |
@ -899,7 +899,7 @@ Returns the generated URL - it will include authentication
information.
| Return type | Description |
|:---|:---|
|:-------------|:------------------------|
| _ByteString_ | Generated presigned URL |
__Example__
@ -941,7 +941,7 @@ The `PostPolicy` argument is created using the `newPostPolicy` function:
In the expression `newPostPolicy expirationTime conditions` the parameters are:
| Param | Type | Description |
|:---|:---|:---|
|:-----------------|:--------------------------------------------------|:---------------------------------------------|
| `expirationTime` | _UTCTime_ (from package `time:Data.Time.UTCTime`) | The expiration time for the policy |
| `conditions` | _[PostPolicyConditions]_ | List of conditions to be added to the policy |

View File

@ -24,7 +24,7 @@ import Control.Monad.IO.Class (liftIO)
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import Control.Monad.Catch (catchIf)
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -31,7 +31,7 @@ import UnliftIO (throwIO, try)
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -26,7 +26,7 @@ import qualified Data.Conduit.Binary as CB
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import Network.Minio.S3API
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import Control.Monad.IO.Class (liftIO)
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import Conduit
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -25,7 +25,7 @@ import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import Network.Minio
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -27,7 +27,7 @@ import qualified Data.Conduit.Combinators as CC
import qualified Data.Text.Encoding as E
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -27,7 +27,7 @@ import qualified Data.Text.Encoding as Enc
import qualified Data.Time as Time
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import qualified Data.ByteString.Char8 as B
import Data.CaseInsensitive (original)
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -25,7 +25,7 @@ import qualified Data.Conduit.Combinators as CC
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -24,7 +24,7 @@ import Network.Minio
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -23,7 +23,7 @@ import Network.Minio
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo

View File

@ -96,7 +96,7 @@ awsRegionMap = Map.fromList [
-- enable the @OverloadedStrings@ language extension and use the
-- `IsString` instance to provide a URL, for example:
--
-- > let c :: ConnectInfo = "https://play.min.io:9000"
-- > let c :: ConnectInfo = "https://play.min.io"
data ConnectInfo =
ConnectInfo { connectHost :: Text
, connectPort :: Int
@ -231,13 +231,13 @@ awsCI :: ConnectInfo
awsCI = "https://s3.amazonaws.com"
-- | <https://play.min.io:9000 MinIO Play Server>
-- | <https://play.min.io MinIO Play Server>
-- ConnectInfo. Credentials are already filled in.
minioPlayCI :: ConnectInfo
minioPlayCI = let playCreds = Credentials "Q3AM3UQ867SPQQA43P2F" "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
in setCreds playCreds
$ setRegion "us-east-1"
"https://play.min.io:9000"
"https://play.min.io"
-- |
-- Represents a bucket in the object store