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

    -- * Request Lenses
    createDocumentationPart_restApiId,
    createDocumentationPart_location,
    createDocumentationPart_properties,

    -- * 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

-- | Creates a new documentation part of a given API.
--
-- /See:/ 'newCreateDocumentationPart' smart constructor.
data CreateDocumentationPart = CreateDocumentationPart'
  { -- | The string identifier of the associated RestApi.
    CreateDocumentationPart -> Text
restApiId :: Prelude.Text,
    -- | The location of the targeted API entity of the to-be-created
    -- documentation part.
    CreateDocumentationPart -> DocumentationPartLocation
location :: DocumentationPartLocation,
    -- | The new documentation content map of the targeted API entity. Enclosed
    -- key-value pairs are API-specific, but only OpenAPI-compliant key-value
    -- pairs can be exported and, hence, published.
    CreateDocumentationPart -> Text
properties :: Prelude.Text
  }
  deriving (CreateDocumentationPart -> CreateDocumentationPart -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CreateDocumentationPart -> CreateDocumentationPart -> Bool
$c/= :: CreateDocumentationPart -> CreateDocumentationPart -> Bool
== :: CreateDocumentationPart -> CreateDocumentationPart -> Bool
$c== :: CreateDocumentationPart -> CreateDocumentationPart -> Bool
Prelude.Eq, ReadPrec [CreateDocumentationPart]
ReadPrec CreateDocumentationPart
Int -> ReadS CreateDocumentationPart
ReadS [CreateDocumentationPart]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CreateDocumentationPart]
$creadListPrec :: ReadPrec [CreateDocumentationPart]
readPrec :: ReadPrec CreateDocumentationPart
$creadPrec :: ReadPrec CreateDocumentationPart
readList :: ReadS [CreateDocumentationPart]
$creadList :: ReadS [CreateDocumentationPart]
readsPrec :: Int -> ReadS CreateDocumentationPart
$creadsPrec :: Int -> ReadS CreateDocumentationPart
Prelude.Read, Int -> CreateDocumentationPart -> ShowS
[CreateDocumentationPart] -> ShowS
CreateDocumentationPart -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CreateDocumentationPart] -> ShowS
$cshowList :: [CreateDocumentationPart] -> ShowS
show :: CreateDocumentationPart -> String
$cshow :: CreateDocumentationPart -> String
showsPrec :: Int -> CreateDocumentationPart -> ShowS
$cshowsPrec :: Int -> CreateDocumentationPart -> ShowS
Prelude.Show, forall x. Rep CreateDocumentationPart x -> CreateDocumentationPart
forall x. CreateDocumentationPart -> Rep CreateDocumentationPart x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CreateDocumentationPart x -> CreateDocumentationPart
$cfrom :: forall x. CreateDocumentationPart -> Rep CreateDocumentationPart x
Prelude.Generic)

-- |
-- Create a value of 'CreateDocumentationPart' 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:
--
-- 'restApiId', 'createDocumentationPart_restApiId' - The string identifier of the associated RestApi.
--
-- 'location', 'createDocumentationPart_location' - The location of the targeted API entity of the to-be-created
-- documentation part.
--
-- 'properties', 'createDocumentationPart_properties' - The new documentation content map of the targeted API entity. Enclosed
-- key-value pairs are API-specific, but only OpenAPI-compliant key-value
-- pairs can be exported and, hence, published.
newCreateDocumentationPart ::
  -- | 'restApiId'
  Prelude.Text ->
  -- | 'location'
  DocumentationPartLocation ->
  -- | 'properties'
  Prelude.Text ->
  CreateDocumentationPart
newCreateDocumentationPart :: Text
-> DocumentationPartLocation -> Text -> CreateDocumentationPart
newCreateDocumentationPart
  Text
pRestApiId_
  DocumentationPartLocation
pLocation_
  Text
pProperties_ =
    CreateDocumentationPart'
      { $sel:restApiId:CreateDocumentationPart' :: Text
restApiId = Text
pRestApiId_,
        $sel:location:CreateDocumentationPart' :: DocumentationPartLocation
location = DocumentationPartLocation
pLocation_,
        $sel:properties:CreateDocumentationPart' :: Text
properties = Text
pProperties_
      }

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

-- | The location of the targeted API entity of the to-be-created
-- documentation part.
createDocumentationPart_location :: Lens.Lens' CreateDocumentationPart DocumentationPartLocation
createDocumentationPart_location :: Lens' CreateDocumentationPart DocumentationPartLocation
createDocumentationPart_location = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateDocumentationPart' {DocumentationPartLocation
location :: DocumentationPartLocation
$sel:location:CreateDocumentationPart' :: CreateDocumentationPart -> DocumentationPartLocation
location} -> DocumentationPartLocation
location) (\s :: CreateDocumentationPart
s@CreateDocumentationPart' {} DocumentationPartLocation
a -> CreateDocumentationPart
s {$sel:location:CreateDocumentationPart' :: DocumentationPartLocation
location = DocumentationPartLocation
a} :: CreateDocumentationPart)

-- | The new documentation content map of the targeted API entity. Enclosed
-- key-value pairs are API-specific, but only OpenAPI-compliant key-value
-- pairs can be exported and, hence, published.
createDocumentationPart_properties :: Lens.Lens' CreateDocumentationPart Prelude.Text
createDocumentationPart_properties :: Lens' CreateDocumentationPart Text
createDocumentationPart_properties = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CreateDocumentationPart' {Text
properties :: Text
$sel:properties:CreateDocumentationPart' :: CreateDocumentationPart -> Text
properties} -> Text
properties) (\s :: CreateDocumentationPart
s@CreateDocumentationPart' {} Text
a -> CreateDocumentationPart
s {$sel:properties:CreateDocumentationPart' :: Text
properties = Text
a} :: CreateDocumentationPart)

instance Core.AWSRequest CreateDocumentationPart where
  type
    AWSResponse CreateDocumentationPart =
      DocumentationPart
  request :: (Service -> Service)
-> CreateDocumentationPart -> Request CreateDocumentationPart
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy CreateDocumentationPart
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse CreateDocumentationPart)))
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 CreateDocumentationPart where
  hashWithSalt :: Int -> CreateDocumentationPart -> Int
hashWithSalt Int
_salt CreateDocumentationPart' {Text
DocumentationPartLocation
properties :: Text
location :: DocumentationPartLocation
restApiId :: Text
$sel:properties:CreateDocumentationPart' :: CreateDocumentationPart -> Text
$sel:location:CreateDocumentationPart' :: CreateDocumentationPart -> DocumentationPartLocation
$sel:restApiId:CreateDocumentationPart' :: CreateDocumentationPart -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
restApiId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DocumentationPartLocation
location
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
properties

instance Prelude.NFData CreateDocumentationPart where
  rnf :: CreateDocumentationPart -> ()
rnf CreateDocumentationPart' {Text
DocumentationPartLocation
properties :: Text
location :: DocumentationPartLocation
restApiId :: Text
$sel:properties:CreateDocumentationPart' :: CreateDocumentationPart -> Text
$sel:location:CreateDocumentationPart' :: CreateDocumentationPart -> DocumentationPartLocation
$sel:restApiId:CreateDocumentationPart' :: CreateDocumentationPart -> Text
..} =
    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 DocumentationPartLocation
location
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
properties

instance Data.ToHeaders CreateDocumentationPart where
  toHeaders :: CreateDocumentationPart -> 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 CreateDocumentationPart where
  toJSON :: CreateDocumentationPart -> Value
toJSON CreateDocumentationPart' {Text
DocumentationPartLocation
properties :: Text
location :: DocumentationPartLocation
restApiId :: Text
$sel:properties:CreateDocumentationPart' :: CreateDocumentationPart -> Text
$sel:location:CreateDocumentationPart' :: CreateDocumentationPart -> DocumentationPartLocation
$sel:restApiId:CreateDocumentationPart' :: CreateDocumentationPart -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"location" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DocumentationPartLocation
location),
            forall a. a -> Maybe a
Prelude.Just (Key
"properties" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
properties)
          ]
      )

instance Data.ToPath CreateDocumentationPart where
  toPath :: CreateDocumentationPart -> ByteString
toPath CreateDocumentationPart' {Text
DocumentationPartLocation
properties :: Text
location :: DocumentationPartLocation
restApiId :: Text
$sel:properties:CreateDocumentationPart' :: CreateDocumentationPart -> Text
$sel:location:CreateDocumentationPart' :: CreateDocumentationPart -> DocumentationPartLocation
$sel:restApiId:CreateDocumentationPart' :: CreateDocumentationPart -> Text
..} =
    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 CreateDocumentationPart where
  toQuery :: CreateDocumentationPart -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty