Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Lists the RestApis
resources for your collection.
This operation returns paginated results.
- getRestAPIs :: GetRestAPIs
- data GetRestAPIs
- graLimit :: Lens' GetRestAPIs (Maybe Int)
- graPosition :: Lens' GetRestAPIs (Maybe Text)
- getRestAPIsResponse :: Int -> GetRestAPIsResponse
- data GetRestAPIsResponse
- grarsItems :: Lens' GetRestAPIsResponse [RestAPI]
- grarsPosition :: Lens' GetRestAPIsResponse (Maybe Text)
- grarsResponseStatus :: Lens' GetRestAPIsResponse Int
Creating a Request
getRestAPIs :: GetRestAPIs Source #
Creates a value of GetRestAPIs
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
graLimit
- The maximum number ofRestApi
resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.graPosition
- The position of the currentRestApis
resource in the collection to get information about.
data GetRestAPIs Source #
The GET request to list existing RestApis
defined for your collection.
See: getRestAPIs
smart constructor.
Request Lenses
graLimit :: Lens' GetRestAPIs (Maybe Int) Source #
The maximum number of RestApi
resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
graPosition :: Lens' GetRestAPIs (Maybe Text) Source #
The position of the current RestApis
resource in the collection to get information about.
Destructuring the Response
Creates a value of GetRestAPIsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
grarsItems
- An array of links to the current page ofRestApi
resources.grarsPosition
- Undocumented member.grarsResponseStatus
- -- | The response status code.
data GetRestAPIsResponse Source #
Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.
See: getRestAPIsResponse
smart constructor.
Response Lenses
grarsItems :: Lens' GetRestAPIsResponse [RestAPI] Source #
An array of links to the current page of RestApi
resources.
grarsPosition :: Lens' GetRestAPIsResponse (Maybe Text) Source #
Undocumented member.
grarsResponseStatus :: Lens' GetRestAPIsResponse Int Source #
- - | The response status code.