{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.APIGateway.GetDocumentationParts
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Gets documentation parts.
--
-- This operation returns paginated results.
module Amazonka.APIGateway.GetDocumentationParts
  ( -- * Creating a Request
    GetDocumentationParts (..),
    newGetDocumentationParts,

    -- * Request Lenses
    getDocumentationParts_limit,
    getDocumentationParts_locationStatus,
    getDocumentationParts_nameQuery,
    getDocumentationParts_path,
    getDocumentationParts_position,
    getDocumentationParts_type,
    getDocumentationParts_restApiId,

    -- * Destructuring the Response
    GetDocumentationPartsResponse (..),
    newGetDocumentationPartsResponse,

    -- * Response Lenses
    getDocumentationPartsResponse_items,
    getDocumentationPartsResponse_position,
    getDocumentationPartsResponse_httpStatus,
  )
where

import Amazonka.APIGateway.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | Gets the documentation parts of an API. The result may be filtered by
-- the type, name, or path of API entities (targets).
--
-- /See:/ 'newGetDocumentationParts' smart constructor.
data GetDocumentationParts = GetDocumentationParts'
  { -- | The maximum number of returned results per page. The default value is 25
    -- and the maximum value is 500.
    GetDocumentationParts -> Maybe Int
limit :: Prelude.Maybe Prelude.Int,
    -- | The status of the API documentation parts to retrieve. Valid values are
    -- @DOCUMENTED@ for retrieving DocumentationPart resources with content and
    -- @UNDOCUMENTED@ for DocumentationPart resources without content.
    GetDocumentationParts -> Maybe LocationStatusType
locationStatus :: Prelude.Maybe LocationStatusType,
    -- | The name of API entities of the to-be-retrieved documentation parts.
    GetDocumentationParts -> Maybe Text
nameQuery :: Prelude.Maybe Prelude.Text,
    -- | The path of API entities of the to-be-retrieved documentation parts.
    GetDocumentationParts -> Maybe Text
path :: Prelude.Maybe Prelude.Text,
    -- | The current pagination position in the paged result set.
    GetDocumentationParts -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The type of API entities of the to-be-retrieved documentation parts.
    GetDocumentationParts -> Maybe DocumentationPartType
type' :: Prelude.Maybe DocumentationPartType,
    -- | The string identifier of the associated RestApi.
    GetDocumentationParts -> Text
restApiId :: Prelude.Text
  }
  deriving (GetDocumentationParts -> GetDocumentationParts -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetDocumentationParts -> GetDocumentationParts -> Bool
$c/= :: GetDocumentationParts -> GetDocumentationParts -> Bool
== :: GetDocumentationParts -> GetDocumentationParts -> Bool
$c== :: GetDocumentationParts -> GetDocumentationParts -> Bool
Prelude.Eq, ReadPrec [GetDocumentationParts]
ReadPrec GetDocumentationParts
Int -> ReadS GetDocumentationParts
ReadS [GetDocumentationParts]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetDocumentationParts]
$creadListPrec :: ReadPrec [GetDocumentationParts]
readPrec :: ReadPrec GetDocumentationParts
$creadPrec :: ReadPrec GetDocumentationParts
readList :: ReadS [GetDocumentationParts]
$creadList :: ReadS [GetDocumentationParts]
readsPrec :: Int -> ReadS GetDocumentationParts
$creadsPrec :: Int -> ReadS GetDocumentationParts
Prelude.Read, Int -> GetDocumentationParts -> ShowS
[GetDocumentationParts] -> ShowS
GetDocumentationParts -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetDocumentationParts] -> ShowS
$cshowList :: [GetDocumentationParts] -> ShowS
show :: GetDocumentationParts -> String
$cshow :: GetDocumentationParts -> String
showsPrec :: Int -> GetDocumentationParts -> ShowS
$cshowsPrec :: Int -> GetDocumentationParts -> ShowS
Prelude.Show, forall x. Rep GetDocumentationParts x -> GetDocumentationParts
forall x. GetDocumentationParts -> Rep GetDocumentationParts x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetDocumentationParts x -> GetDocumentationParts
$cfrom :: forall x. GetDocumentationParts -> Rep GetDocumentationParts x
Prelude.Generic)

-- |
-- Create a value of 'GetDocumentationParts' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'limit', 'getDocumentationParts_limit' - The maximum number of returned results per page. The default value is 25
-- and the maximum value is 500.
--
-- 'locationStatus', 'getDocumentationParts_locationStatus' - The status of the API documentation parts to retrieve. Valid values are
-- @DOCUMENTED@ for retrieving DocumentationPart resources with content and
-- @UNDOCUMENTED@ for DocumentationPart resources without content.
--
-- 'nameQuery', 'getDocumentationParts_nameQuery' - The name of API entities of the to-be-retrieved documentation parts.
--
-- 'path', 'getDocumentationParts_path' - The path of API entities of the to-be-retrieved documentation parts.
--
-- 'position', 'getDocumentationParts_position' - The current pagination position in the paged result set.
--
-- 'type'', 'getDocumentationParts_type' - The type of API entities of the to-be-retrieved documentation parts.
--
-- 'restApiId', 'getDocumentationParts_restApiId' - The string identifier of the associated RestApi.
newGetDocumentationParts ::
  -- | 'restApiId'
  Prelude.Text ->
  GetDocumentationParts
newGetDocumentationParts :: Text -> GetDocumentationParts
newGetDocumentationParts Text
pRestApiId_ =
  GetDocumentationParts'
    { $sel:limit:GetDocumentationParts' :: Maybe Int
limit = forall a. Maybe a
Prelude.Nothing,
      $sel:locationStatus:GetDocumentationParts' :: Maybe LocationStatusType
locationStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:nameQuery:GetDocumentationParts' :: Maybe Text
nameQuery = forall a. Maybe a
Prelude.Nothing,
      $sel:path:GetDocumentationParts' :: Maybe Text
path = forall a. Maybe a
Prelude.Nothing,
      $sel:position:GetDocumentationParts' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:type':GetDocumentationParts' :: Maybe DocumentationPartType
type' = forall a. Maybe a
Prelude.Nothing,
      $sel:restApiId:GetDocumentationParts' :: Text
restApiId = Text
pRestApiId_
    }

-- | The maximum number of returned results per page. The default value is 25
-- and the maximum value is 500.
getDocumentationParts_limit :: Lens.Lens' GetDocumentationParts (Prelude.Maybe Prelude.Int)
getDocumentationParts_limit :: Lens' GetDocumentationParts (Maybe Int)
getDocumentationParts_limit = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Maybe Int
limit :: Maybe Int
$sel:limit:GetDocumentationParts' :: GetDocumentationParts -> Maybe Int
limit} -> Maybe Int
limit) (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Maybe Int
a -> GetDocumentationParts
s {$sel:limit:GetDocumentationParts' :: Maybe Int
limit = Maybe Int
a} :: GetDocumentationParts)

-- | The status of the API documentation parts to retrieve. Valid values are
-- @DOCUMENTED@ for retrieving DocumentationPart resources with content and
-- @UNDOCUMENTED@ for DocumentationPart resources without content.
getDocumentationParts_locationStatus :: Lens.Lens' GetDocumentationParts (Prelude.Maybe LocationStatusType)
getDocumentationParts_locationStatus :: Lens' GetDocumentationParts (Maybe LocationStatusType)
getDocumentationParts_locationStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Maybe LocationStatusType
locationStatus :: Maybe LocationStatusType
$sel:locationStatus:GetDocumentationParts' :: GetDocumentationParts -> Maybe LocationStatusType
locationStatus} -> Maybe LocationStatusType
locationStatus) (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Maybe LocationStatusType
a -> GetDocumentationParts
s {$sel:locationStatus:GetDocumentationParts' :: Maybe LocationStatusType
locationStatus = Maybe LocationStatusType
a} :: GetDocumentationParts)

-- | The name of API entities of the to-be-retrieved documentation parts.
getDocumentationParts_nameQuery :: Lens.Lens' GetDocumentationParts (Prelude.Maybe Prelude.Text)
getDocumentationParts_nameQuery :: Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_nameQuery = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Maybe Text
nameQuery :: Maybe Text
$sel:nameQuery:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
nameQuery} -> Maybe Text
nameQuery) (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Maybe Text
a -> GetDocumentationParts
s {$sel:nameQuery:GetDocumentationParts' :: Maybe Text
nameQuery = Maybe Text
a} :: GetDocumentationParts)

-- | The path of API entities of the to-be-retrieved documentation parts.
getDocumentationParts_path :: Lens.Lens' GetDocumentationParts (Prelude.Maybe Prelude.Text)
getDocumentationParts_path :: Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_path = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Maybe Text
path :: Maybe Text
$sel:path:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
path} -> Maybe Text
path) (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Maybe Text
a -> GetDocumentationParts
s {$sel:path:GetDocumentationParts' :: Maybe Text
path = Maybe Text
a} :: GetDocumentationParts)

-- | The current pagination position in the paged result set.
getDocumentationParts_position :: Lens.Lens' GetDocumentationParts (Prelude.Maybe Prelude.Text)
getDocumentationParts_position :: Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Maybe Text
position :: Maybe Text
$sel:position:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
position} -> Maybe Text
position) (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Maybe Text
a -> GetDocumentationParts
s {$sel:position:GetDocumentationParts' :: Maybe Text
position = Maybe Text
a} :: GetDocumentationParts)

-- | The type of API entities of the to-be-retrieved documentation parts.
getDocumentationParts_type :: Lens.Lens' GetDocumentationParts (Prelude.Maybe DocumentationPartType)
getDocumentationParts_type :: Lens' GetDocumentationParts (Maybe DocumentationPartType)
getDocumentationParts_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Maybe DocumentationPartType
type' :: Maybe DocumentationPartType
$sel:type':GetDocumentationParts' :: GetDocumentationParts -> Maybe DocumentationPartType
type'} -> Maybe DocumentationPartType
type') (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Maybe DocumentationPartType
a -> GetDocumentationParts
s {$sel:type':GetDocumentationParts' :: Maybe DocumentationPartType
type' = Maybe DocumentationPartType
a} :: GetDocumentationParts)

-- | The string identifier of the associated RestApi.
getDocumentationParts_restApiId :: Lens.Lens' GetDocumentationParts Prelude.Text
getDocumentationParts_restApiId :: Lens' GetDocumentationParts Text
getDocumentationParts_restApiId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationParts' {Text
restApiId :: Text
$sel:restApiId:GetDocumentationParts' :: GetDocumentationParts -> Text
restApiId} -> Text
restApiId) (\s :: GetDocumentationParts
s@GetDocumentationParts' {} Text
a -> GetDocumentationParts
s {$sel:restApiId:GetDocumentationParts' :: Text
restApiId = Text
a} :: GetDocumentationParts)

instance Core.AWSPager GetDocumentationParts where
  page :: GetDocumentationParts
-> AWSResponse GetDocumentationParts -> Maybe GetDocumentationParts
page GetDocumentationParts
rq AWSResponse GetDocumentationParts
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetDocumentationParts
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetDocumentationPartsResponse (Maybe Text)
getDocumentationPartsResponse_position
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse GetDocumentationParts
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetDocumentationPartsResponse (Maybe [DocumentationPart])
getDocumentationPartsResponse_items
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ GetDocumentationParts
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' GetDocumentationParts (Maybe Text)
getDocumentationParts_position
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse GetDocumentationParts
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' GetDocumentationPartsResponse (Maybe Text)
getDocumentationPartsResponse_position
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest GetDocumentationParts where
  type
    AWSResponse GetDocumentationParts =
      GetDocumentationPartsResponse
  request :: (Service -> Service)
-> GetDocumentationParts -> Request GetDocumentationParts
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy GetDocumentationParts
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetDocumentationParts)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe [DocumentationPart]
-> Maybe Text -> Int -> GetDocumentationPartsResponse
GetDocumentationPartsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"item" forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"position")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable GetDocumentationParts where
  hashWithSalt :: Int -> GetDocumentationParts -> Int
hashWithSalt Int
_salt GetDocumentationParts' {Maybe Int
Maybe Text
Maybe DocumentationPartType
Maybe LocationStatusType
Text
restApiId :: Text
type' :: Maybe DocumentationPartType
position :: Maybe Text
path :: Maybe Text
nameQuery :: Maybe Text
locationStatus :: Maybe LocationStatusType
limit :: Maybe Int
$sel:restApiId:GetDocumentationParts' :: GetDocumentationParts -> Text
$sel:type':GetDocumentationParts' :: GetDocumentationParts -> Maybe DocumentationPartType
$sel:position:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:path:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:nameQuery:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:locationStatus:GetDocumentationParts' :: GetDocumentationParts -> Maybe LocationStatusType
$sel:limit:GetDocumentationParts' :: GetDocumentationParts -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
limit
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe LocationStatusType
locationStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nameQuery
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
path
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
position
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DocumentationPartType
type'
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
restApiId

instance Prelude.NFData GetDocumentationParts where
  rnf :: GetDocumentationParts -> ()
rnf GetDocumentationParts' {Maybe Int
Maybe Text
Maybe DocumentationPartType
Maybe LocationStatusType
Text
restApiId :: Text
type' :: Maybe DocumentationPartType
position :: Maybe Text
path :: Maybe Text
nameQuery :: Maybe Text
locationStatus :: Maybe LocationStatusType
limit :: Maybe Int
$sel:restApiId:GetDocumentationParts' :: GetDocumentationParts -> Text
$sel:type':GetDocumentationParts' :: GetDocumentationParts -> Maybe DocumentationPartType
$sel:position:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:path:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:nameQuery:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:locationStatus:GetDocumentationParts' :: GetDocumentationParts -> Maybe LocationStatusType
$sel:limit:GetDocumentationParts' :: GetDocumentationParts -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
limit
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe LocationStatusType
locationStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nameQuery
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
path
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
position
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DocumentationPartType
type'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
restApiId

instance Data.ToHeaders GetDocumentationParts where
  toHeaders :: GetDocumentationParts -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Accept"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"application/json" :: Prelude.ByteString)
          ]
      )

instance Data.ToPath GetDocumentationParts where
  toPath :: GetDocumentationParts -> ByteString
toPath GetDocumentationParts' {Maybe Int
Maybe Text
Maybe DocumentationPartType
Maybe LocationStatusType
Text
restApiId :: Text
type' :: Maybe DocumentationPartType
position :: Maybe Text
path :: Maybe Text
nameQuery :: Maybe Text
locationStatus :: Maybe LocationStatusType
limit :: Maybe Int
$sel:restApiId:GetDocumentationParts' :: GetDocumentationParts -> Text
$sel:type':GetDocumentationParts' :: GetDocumentationParts -> Maybe DocumentationPartType
$sel:position:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:path:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:nameQuery:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:locationStatus:GetDocumentationParts' :: GetDocumentationParts -> Maybe LocationStatusType
$sel:limit:GetDocumentationParts' :: GetDocumentationParts -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/restapis/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
restApiId,
        ByteString
"/documentation/parts"
      ]

instance Data.ToQuery GetDocumentationParts where
  toQuery :: GetDocumentationParts -> QueryString
toQuery GetDocumentationParts' {Maybe Int
Maybe Text
Maybe DocumentationPartType
Maybe LocationStatusType
Text
restApiId :: Text
type' :: Maybe DocumentationPartType
position :: Maybe Text
path :: Maybe Text
nameQuery :: Maybe Text
locationStatus :: Maybe LocationStatusType
limit :: Maybe Int
$sel:restApiId:GetDocumentationParts' :: GetDocumentationParts -> Text
$sel:type':GetDocumentationParts' :: GetDocumentationParts -> Maybe DocumentationPartType
$sel:position:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:path:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:nameQuery:GetDocumentationParts' :: GetDocumentationParts -> Maybe Text
$sel:locationStatus:GetDocumentationParts' :: GetDocumentationParts -> Maybe LocationStatusType
$sel:limit:GetDocumentationParts' :: GetDocumentationParts -> Maybe Int
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"limit" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Int
limit,
        ByteString
"locationStatus" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe LocationStatusType
locationStatus,
        ByteString
"name" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
nameQuery,
        ByteString
"path" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
path,
        ByteString
"position" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
position,
        ByteString
"type" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe DocumentationPartType
type'
      ]

-- | The collection of documentation parts of an API.
--
-- /See:/ 'newGetDocumentationPartsResponse' smart constructor.
data GetDocumentationPartsResponse = GetDocumentationPartsResponse'
  { -- | The current page of elements from this collection.
    GetDocumentationPartsResponse -> Maybe [DocumentationPart]
items :: Prelude.Maybe [DocumentationPart],
    GetDocumentationPartsResponse -> Maybe Text
position :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    GetDocumentationPartsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetDocumentationPartsResponse
-> GetDocumentationPartsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetDocumentationPartsResponse
-> GetDocumentationPartsResponse -> Bool
$c/= :: GetDocumentationPartsResponse
-> GetDocumentationPartsResponse -> Bool
== :: GetDocumentationPartsResponse
-> GetDocumentationPartsResponse -> Bool
$c== :: GetDocumentationPartsResponse
-> GetDocumentationPartsResponse -> Bool
Prelude.Eq, ReadPrec [GetDocumentationPartsResponse]
ReadPrec GetDocumentationPartsResponse
Int -> ReadS GetDocumentationPartsResponse
ReadS [GetDocumentationPartsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetDocumentationPartsResponse]
$creadListPrec :: ReadPrec [GetDocumentationPartsResponse]
readPrec :: ReadPrec GetDocumentationPartsResponse
$creadPrec :: ReadPrec GetDocumentationPartsResponse
readList :: ReadS [GetDocumentationPartsResponse]
$creadList :: ReadS [GetDocumentationPartsResponse]
readsPrec :: Int -> ReadS GetDocumentationPartsResponse
$creadsPrec :: Int -> ReadS GetDocumentationPartsResponse
Prelude.Read, Int -> GetDocumentationPartsResponse -> ShowS
[GetDocumentationPartsResponse] -> ShowS
GetDocumentationPartsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetDocumentationPartsResponse] -> ShowS
$cshowList :: [GetDocumentationPartsResponse] -> ShowS
show :: GetDocumentationPartsResponse -> String
$cshow :: GetDocumentationPartsResponse -> String
showsPrec :: Int -> GetDocumentationPartsResponse -> ShowS
$cshowsPrec :: Int -> GetDocumentationPartsResponse -> ShowS
Prelude.Show, forall x.
Rep GetDocumentationPartsResponse x
-> GetDocumentationPartsResponse
forall x.
GetDocumentationPartsResponse
-> Rep GetDocumentationPartsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetDocumentationPartsResponse x
-> GetDocumentationPartsResponse
$cfrom :: forall x.
GetDocumentationPartsResponse
-> Rep GetDocumentationPartsResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetDocumentationPartsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'items', 'getDocumentationPartsResponse_items' - The current page of elements from this collection.
--
-- 'position', 'getDocumentationPartsResponse_position' - Undocumented member.
--
-- 'httpStatus', 'getDocumentationPartsResponse_httpStatus' - The response's http status code.
newGetDocumentationPartsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetDocumentationPartsResponse
newGetDocumentationPartsResponse :: Int -> GetDocumentationPartsResponse
newGetDocumentationPartsResponse Int
pHttpStatus_ =
  GetDocumentationPartsResponse'
    { $sel:items:GetDocumentationPartsResponse' :: Maybe [DocumentationPart]
items =
        forall a. Maybe a
Prelude.Nothing,
      $sel:position:GetDocumentationPartsResponse' :: Maybe Text
position = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetDocumentationPartsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The current page of elements from this collection.
getDocumentationPartsResponse_items :: Lens.Lens' GetDocumentationPartsResponse (Prelude.Maybe [DocumentationPart])
getDocumentationPartsResponse_items :: Lens' GetDocumentationPartsResponse (Maybe [DocumentationPart])
getDocumentationPartsResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationPartsResponse' {Maybe [DocumentationPart]
items :: Maybe [DocumentationPart]
$sel:items:GetDocumentationPartsResponse' :: GetDocumentationPartsResponse -> Maybe [DocumentationPart]
items} -> Maybe [DocumentationPart]
items) (\s :: GetDocumentationPartsResponse
s@GetDocumentationPartsResponse' {} Maybe [DocumentationPart]
a -> GetDocumentationPartsResponse
s {$sel:items:GetDocumentationPartsResponse' :: Maybe [DocumentationPart]
items = Maybe [DocumentationPart]
a} :: GetDocumentationPartsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Undocumented member.
getDocumentationPartsResponse_position :: Lens.Lens' GetDocumentationPartsResponse (Prelude.Maybe Prelude.Text)
getDocumentationPartsResponse_position :: Lens' GetDocumentationPartsResponse (Maybe Text)
getDocumentationPartsResponse_position = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationPartsResponse' {Maybe Text
position :: Maybe Text
$sel:position:GetDocumentationPartsResponse' :: GetDocumentationPartsResponse -> Maybe Text
position} -> Maybe Text
position) (\s :: GetDocumentationPartsResponse
s@GetDocumentationPartsResponse' {} Maybe Text
a -> GetDocumentationPartsResponse
s {$sel:position:GetDocumentationPartsResponse' :: Maybe Text
position = Maybe Text
a} :: GetDocumentationPartsResponse)

-- | The response's http status code.
getDocumentationPartsResponse_httpStatus :: Lens.Lens' GetDocumentationPartsResponse Prelude.Int
getDocumentationPartsResponse_httpStatus :: Lens' GetDocumentationPartsResponse Int
getDocumentationPartsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetDocumentationPartsResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetDocumentationPartsResponse' :: GetDocumentationPartsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetDocumentationPartsResponse
s@GetDocumentationPartsResponse' {} Int
a -> GetDocumentationPartsResponse
s {$sel:httpStatus:GetDocumentationPartsResponse' :: Int
httpStatus = Int
a} :: GetDocumentationPartsResponse)

instance Prelude.NFData GetDocumentationPartsResponse where
  rnf :: GetDocumentationPartsResponse -> ()
rnf GetDocumentationPartsResponse' {Int
Maybe [DocumentationPart]
Maybe Text
httpStatus :: Int
position :: Maybe Text
items :: Maybe [DocumentationPart]
$sel:httpStatus:GetDocumentationPartsResponse' :: GetDocumentationPartsResponse -> Int
$sel:position:GetDocumentationPartsResponse' :: GetDocumentationPartsResponse -> Maybe Text
$sel:items:GetDocumentationPartsResponse' :: GetDocumentationPartsResponse -> Maybe [DocumentationPart]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [DocumentationPart]
items
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
position
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus