{-# 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.UpdateDocumentationPart
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Updates a documentation part.
module Amazonka.APIGateway.UpdateDocumentationPart
  ( -- * Creating a Request
    UpdateDocumentationPart (..),
    newUpdateDocumentationPart,

    -- * Request Lenses
    updateDocumentationPart_patchOperations,
    updateDocumentationPart_restApiId,
    updateDocumentationPart_documentationPartId,

    -- * Destructuring the Response
    DocumentationPart (..),
    newDocumentationPart,

    -- * Response Lenses
    documentationPart_id,
    documentationPart_location,
    documentationPart_properties,
  )
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

-- | Updates an existing documentation part of a given API.
--
-- /See:/ 'newUpdateDocumentationPart' smart constructor.
data UpdateDocumentationPart = UpdateDocumentationPart'
  { -- | For more information about supported patch operations, see
    -- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
    UpdateDocumentationPart -> Maybe [PatchOperation]
patchOperations :: Prelude.Maybe [PatchOperation],
    -- | The string identifier of the associated RestApi.
    UpdateDocumentationPart -> Text
restApiId :: Prelude.Text,
    -- | The identifier of the to-be-updated documentation part.
    UpdateDocumentationPart -> Text
documentationPartId :: Prelude.Text
  }
  deriving (UpdateDocumentationPart -> UpdateDocumentationPart -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool
$c/= :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool
== :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool
$c== :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool
Prelude.Eq, ReadPrec [UpdateDocumentationPart]
ReadPrec UpdateDocumentationPart
Int -> ReadS UpdateDocumentationPart
ReadS [UpdateDocumentationPart]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UpdateDocumentationPart]
$creadListPrec :: ReadPrec [UpdateDocumentationPart]
readPrec :: ReadPrec UpdateDocumentationPart
$creadPrec :: ReadPrec UpdateDocumentationPart
readList :: ReadS [UpdateDocumentationPart]
$creadList :: ReadS [UpdateDocumentationPart]
readsPrec :: Int -> ReadS UpdateDocumentationPart
$creadsPrec :: Int -> ReadS UpdateDocumentationPart
Prelude.Read, Int -> UpdateDocumentationPart -> ShowS
[UpdateDocumentationPart] -> ShowS
UpdateDocumentationPart -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UpdateDocumentationPart] -> ShowS
$cshowList :: [UpdateDocumentationPart] -> ShowS
show :: UpdateDocumentationPart -> String
$cshow :: UpdateDocumentationPart -> String
showsPrec :: Int -> UpdateDocumentationPart -> ShowS
$cshowsPrec :: Int -> UpdateDocumentationPart -> ShowS
Prelude.Show, forall x. Rep UpdateDocumentationPart x -> UpdateDocumentationPart
forall x. UpdateDocumentationPart -> Rep UpdateDocumentationPart x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep UpdateDocumentationPart x -> UpdateDocumentationPart
$cfrom :: forall x. UpdateDocumentationPart -> Rep UpdateDocumentationPart x
Prelude.Generic)

-- |
-- Create a value of 'UpdateDocumentationPart' 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:
--
-- 'patchOperations', 'updateDocumentationPart_patchOperations' - For more information about supported patch operations, see
-- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
--
-- 'restApiId', 'updateDocumentationPart_restApiId' - The string identifier of the associated RestApi.
--
-- 'documentationPartId', 'updateDocumentationPart_documentationPartId' - The identifier of the to-be-updated documentation part.
newUpdateDocumentationPart ::
  -- | 'restApiId'
  Prelude.Text ->
  -- | 'documentationPartId'
  Prelude.Text ->
  UpdateDocumentationPart
newUpdateDocumentationPart :: Text -> Text -> UpdateDocumentationPart
newUpdateDocumentationPart
  Text
pRestApiId_
  Text
pDocumentationPartId_ =
    UpdateDocumentationPart'
      { $sel:patchOperations:UpdateDocumentationPart' :: Maybe [PatchOperation]
patchOperations =
          forall a. Maybe a
Prelude.Nothing,
        $sel:restApiId:UpdateDocumentationPart' :: Text
restApiId = Text
pRestApiId_,
        $sel:documentationPartId:UpdateDocumentationPart' :: Text
documentationPartId = Text
pDocumentationPartId_
      }

-- | For more information about supported patch operations, see
-- <https://docs.aws.amazon.com/apigateway/latest/api/patch-operations.html Patch Operations>.
updateDocumentationPart_patchOperations :: Lens.Lens' UpdateDocumentationPart (Prelude.Maybe [PatchOperation])
updateDocumentationPart_patchOperations :: Lens' UpdateDocumentationPart (Maybe [PatchOperation])
updateDocumentationPart_patchOperations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateDocumentationPart' {Maybe [PatchOperation]
patchOperations :: Maybe [PatchOperation]
$sel:patchOperations:UpdateDocumentationPart' :: UpdateDocumentationPart -> Maybe [PatchOperation]
patchOperations} -> Maybe [PatchOperation]
patchOperations) (\s :: UpdateDocumentationPart
s@UpdateDocumentationPart' {} Maybe [PatchOperation]
a -> UpdateDocumentationPart
s {$sel:patchOperations:UpdateDocumentationPart' :: Maybe [PatchOperation]
patchOperations = Maybe [PatchOperation]
a} :: UpdateDocumentationPart) 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

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

-- | The identifier of the to-be-updated documentation part.
updateDocumentationPart_documentationPartId :: Lens.Lens' UpdateDocumentationPart Prelude.Text
updateDocumentationPart_documentationPartId :: Lens' UpdateDocumentationPart Text
updateDocumentationPart_documentationPartId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UpdateDocumentationPart' {Text
documentationPartId :: Text
$sel:documentationPartId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
documentationPartId} -> Text
documentationPartId) (\s :: UpdateDocumentationPart
s@UpdateDocumentationPart' {} Text
a -> UpdateDocumentationPart
s {$sel:documentationPartId:UpdateDocumentationPart' :: Text
documentationPartId = Text
a} :: UpdateDocumentationPart)

instance Core.AWSRequest UpdateDocumentationPart where
  type
    AWSResponse UpdateDocumentationPart =
      DocumentationPart
  request :: (Service -> Service)
-> UpdateDocumentationPart -> Request UpdateDocumentationPart
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.patchJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy UpdateDocumentationPart
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse UpdateDocumentationPart)))
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 -> forall a. FromJSON a => Object -> Either String a
Data.eitherParseJSON Object
x)

instance Prelude.Hashable UpdateDocumentationPart where
  hashWithSalt :: Int -> UpdateDocumentationPart -> Int
hashWithSalt Int
_salt UpdateDocumentationPart' {Maybe [PatchOperation]
Text
documentationPartId :: Text
restApiId :: Text
patchOperations :: Maybe [PatchOperation]
$sel:documentationPartId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:restApiId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:patchOperations:UpdateDocumentationPart' :: UpdateDocumentationPart -> Maybe [PatchOperation]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [PatchOperation]
patchOperations
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
restApiId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
documentationPartId

instance Prelude.NFData UpdateDocumentationPart where
  rnf :: UpdateDocumentationPart -> ()
rnf UpdateDocumentationPart' {Maybe [PatchOperation]
Text
documentationPartId :: Text
restApiId :: Text
patchOperations :: Maybe [PatchOperation]
$sel:documentationPartId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:restApiId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:patchOperations:UpdateDocumentationPart' :: UpdateDocumentationPart -> Maybe [PatchOperation]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [PatchOperation]
patchOperations
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
restApiId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
documentationPartId

instance Data.ToHeaders UpdateDocumentationPart where
  toHeaders :: UpdateDocumentationPart -> 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.ToJSON UpdateDocumentationPart where
  toJSON :: UpdateDocumentationPart -> Value
toJSON UpdateDocumentationPart' {Maybe [PatchOperation]
Text
documentationPartId :: Text
restApiId :: Text
patchOperations :: Maybe [PatchOperation]
$sel:documentationPartId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:restApiId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:patchOperations:UpdateDocumentationPart' :: UpdateDocumentationPart -> Maybe [PatchOperation]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"patchOperations" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [PatchOperation]
patchOperations
          ]
      )

instance Data.ToPath UpdateDocumentationPart where
  toPath :: UpdateDocumentationPart -> ByteString
toPath UpdateDocumentationPart' {Maybe [PatchOperation]
Text
documentationPartId :: Text
restApiId :: Text
patchOperations :: Maybe [PatchOperation]
$sel:documentationPartId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:restApiId:UpdateDocumentationPart' :: UpdateDocumentationPart -> Text
$sel:patchOperations:UpdateDocumentationPart' :: UpdateDocumentationPart -> Maybe [PatchOperation]
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/restapis/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
restApiId,
        ByteString
"/documentation/parts/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
documentationPartId
      ]

instance Data.ToQuery UpdateDocumentationPart where
  toQuery :: UpdateDocumentationPart -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty