Copyright | (c) 2015 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 |
- Service Configuration
- API Declaration
- Resources
- Types
- RestMethodResponse
- RestDescriptionParameters
- RestMethod
- RestResource
- RestDescriptionAuthOAuth2Scopes
- RestDescriptionMethods
- DirectoryListItemsItem
- DirectoryListItemsItemIcons
- RestResourceResources
- RestDescriptionAuthOAuth2
- RestDescriptionAuthOAuth2ScopesAdditional
- RestMethodMediaUploadProtocolsSimple
- RestDescriptionIcons
- JSONSchemaVariant
- RestResourceMethods
- RestDescriptionAuth
- RestDescription
- JSONSchema
- RestDescriptionSchemas
- JSONSchemaVariantMapItem
- RestDescriptionResources
- RestMethodMediaUploadProtocols
- JSONSchemaAnnotations
- RestMethodParameters
- RestMethodMediaUpload
- JSONSchemaProperties
- RestMethodMediaUploadProtocolsResumable
- DirectoryList
- RestMethodRequest
Lets you discover information about other Google APIs, such as what APIs are available, the resource and method details for each API.
- discoveryService :: Service
- type DiscoveryAPI = APIsListResource :<|> APIsGetRestResource
- module Network.Google.Resource.Discovery.APIs.GetRest
- module Network.Google.Resource.Discovery.APIs.List
- data RestMethodResponse
- restMethodResponse :: RestMethodResponse
- rmrRef :: Lens' RestMethodResponse (Maybe Text)
- data RestDescriptionParameters
- restDescriptionParameters :: HashMap Text JSONSchema -> RestDescriptionParameters
- rdpAddtional :: Lens' RestDescriptionParameters (HashMap Text JSONSchema)
- data RestMethod
- restMethod :: RestMethod
- rmSupportsMediaDownload :: Lens' RestMethod (Maybe Bool)
- rmParameterOrder :: Lens' RestMethod [Text]
- rmMediaUpload :: Lens' RestMethod (Maybe RestMethodMediaUpload)
- rmHTTPMethod :: Lens' RestMethod (Maybe Text)
- rmPath :: Lens' RestMethod (Maybe Text)
- rmResponse :: Lens' RestMethod (Maybe RestMethodResponse)
- rmSupportsMediaUpload :: Lens' RestMethod (Maybe Bool)
- rmScopes :: Lens' RestMethod [Text]
- rmSupportsSubscription :: Lens' RestMethod (Maybe Bool)
- rmParameters :: Lens' RestMethod (Maybe RestMethodParameters)
- rmId :: Lens' RestMethod (Maybe Text)
- rmEtagRequired :: Lens' RestMethod (Maybe Bool)
- rmUseMediaDownloadService :: Lens' RestMethod (Maybe Bool)
- rmDescription :: Lens' RestMethod (Maybe Text)
- rmRequest :: Lens' RestMethod (Maybe RestMethodRequest)
- data RestResource
- restResource :: RestResource
- rrResources :: Lens' RestResource (Maybe RestResourceResources)
- rrMethods :: Lens' RestResource (Maybe RestResourceMethods)
- data RestDescriptionAuthOAuth2Scopes
- restDescriptionAuthOAuth2Scopes :: HashMap Text RestDescriptionAuthOAuth2ScopesAdditional -> RestDescriptionAuthOAuth2Scopes
- rdaoasAddtional :: Lens' RestDescriptionAuthOAuth2Scopes (HashMap Text RestDescriptionAuthOAuth2ScopesAdditional)
- data RestDescriptionMethods
- restDescriptionMethods :: HashMap Text RestMethod -> RestDescriptionMethods
- rdmAddtional :: Lens' RestDescriptionMethods (HashMap Text RestMethod)
- data DirectoryListItemsItem
- directoryListItemsItem :: DirectoryListItemsItem
- dliiDiscoveryLink :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiPreferred :: Lens' DirectoryListItemsItem (Maybe Bool)
- dliiKind :: Lens' DirectoryListItemsItem Text
- dliiIcons :: Lens' DirectoryListItemsItem (Maybe DirectoryListItemsItemIcons)
- dliiName :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiVersion :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiDocumentationLink :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiId :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiLabels :: Lens' DirectoryListItemsItem [Text]
- dliiTitle :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiDescription :: Lens' DirectoryListItemsItem (Maybe Text)
- dliiDiscoveryRestURL :: Lens' DirectoryListItemsItem (Maybe Text)
- data DirectoryListItemsItemIcons
- directoryListItemsItemIcons :: DirectoryListItemsItemIcons
- dliiiX16 :: Lens' DirectoryListItemsItemIcons (Maybe Text)
- dliiiX32 :: Lens' DirectoryListItemsItemIcons (Maybe Text)
- data RestResourceResources
- restResourceResources :: HashMap Text RestResource -> RestResourceResources
- rrrAddtional :: Lens' RestResourceResources (HashMap Text RestResource)
- data RestDescriptionAuthOAuth2
- restDescriptionAuthOAuth2 :: RestDescriptionAuthOAuth2
- rdaoaScopes :: Lens' RestDescriptionAuthOAuth2 (Maybe RestDescriptionAuthOAuth2Scopes)
- data RestDescriptionAuthOAuth2ScopesAdditional
- restDescriptionAuthOAuth2ScopesAdditional :: RestDescriptionAuthOAuth2ScopesAdditional
- rdaoasaDescription :: Lens' RestDescriptionAuthOAuth2ScopesAdditional (Maybe Text)
- data RestMethodMediaUploadProtocolsSimple
- restMethodMediaUploadProtocolsSimple :: RestMethodMediaUploadProtocolsSimple
- rmmupsPath :: Lens' RestMethodMediaUploadProtocolsSimple (Maybe Text)
- rmmupsMultiPart :: Lens' RestMethodMediaUploadProtocolsSimple Bool
- data RestDescriptionIcons
- restDescriptionIcons :: RestDescriptionIcons
- rdiX16 :: Lens' RestDescriptionIcons (Maybe Text)
- rdiX32 :: Lens' RestDescriptionIcons (Maybe Text)
- data JSONSchemaVariant
- jsonSchemaVariant :: JSONSchemaVariant
- jsvDiscriminant :: Lens' JSONSchemaVariant (Maybe Text)
- jsvMap :: Lens' JSONSchemaVariant [JSONSchemaVariantMapItem]
- data RestResourceMethods
- restResourceMethods :: HashMap Text RestMethod -> RestResourceMethods
- rrmAddtional :: Lens' RestResourceMethods (HashMap Text RestMethod)
- data RestDescriptionAuth
- restDescriptionAuth :: RestDescriptionAuth
- rdaOAuth2 :: Lens' RestDescriptionAuth (Maybe RestDescriptionAuthOAuth2)
- data RestDescription
- restDescription :: RestDescription
- rdEtag :: Lens' RestDescription (Maybe Text)
- rdSchemas :: Lens' RestDescription (Maybe RestDescriptionSchemas)
- rdServicePath :: Lens' RestDescription (Maybe Text)
- rdBasePath :: Lens' RestDescription (Maybe Text)
- rdKind :: Lens' RestDescription Text
- rdExponentialBackoffDefault :: Lens' RestDescription (Maybe Bool)
- rdAuth :: Lens' RestDescription (Maybe RestDescriptionAuth)
- rdIcons :: Lens' RestDescription (Maybe RestDescriptionIcons)
- rdBaseURL :: Lens' RestDescription (Maybe Text)
- rdProtocol :: Lens' RestDescription Text
- rdOwnerName :: Lens' RestDescription (Maybe Text)
- rdResources :: Lens' RestDescription (Maybe RestDescriptionResources)
- rdOwnerDomain :: Lens' RestDescription (Maybe Text)
- rdBatchPath :: Lens' RestDescription Text
- rdMethods :: Lens' RestDescription (Maybe RestDescriptionMethods)
- rdName :: Lens' RestDescription (Maybe Text)
- rdPackagePath :: Lens' RestDescription (Maybe Text)
- rdFeatures :: Lens' RestDescription [Text]
- rdVersion :: Lens' RestDescription (Maybe Text)
- rdParameters :: Lens' RestDescription (Maybe RestDescriptionParameters)
- rdDocumentationLink :: Lens' RestDescription (Maybe Text)
- rdRootURL :: Lens' RestDescription (Maybe Text)
- rdId :: Lens' RestDescription (Maybe Text)
- rdCanonicalName :: Lens' RestDescription (Maybe Text)
- rdLabels :: Lens' RestDescription [Text]
- rdDiscoveryVersion :: Lens' RestDescription Text
- rdTitle :: Lens' RestDescription (Maybe Text)
- rdRevision :: Lens' RestDescription (Maybe Text)
- rdDescription :: Lens' RestDescription (Maybe Text)
- data JSONSchema
- jsonSchema :: JSONSchema
- jsAnnotations :: Lens' JSONSchema (Maybe JSONSchemaAnnotations)
- jsVariant :: Lens' JSONSchema (Maybe JSONSchemaVariant)
- jsLocation :: Lens' JSONSchema (Maybe Text)
- jsRef :: Lens' JSONSchema (Maybe Text)
- jsPattern :: Lens' JSONSchema (Maybe Text)
- jsMaximum :: Lens' JSONSchema (Maybe Text)
- jsDefault :: Lens' JSONSchema (Maybe Text)
- jsFormat :: Lens' JSONSchema (Maybe Text)
- jsItems :: Lens' JSONSchema (Maybe JSONSchema)
- jsMinimum :: Lens' JSONSchema (Maybe Text)
- jsRequired :: Lens' JSONSchema (Maybe Bool)
- jsId :: Lens' JSONSchema (Maybe Text)
- jsAdditionalProperties :: Lens' JSONSchema (Maybe JSONSchema)
- jsType :: Lens' JSONSchema (Maybe Text)
- jsEnum :: Lens' JSONSchema [Text]
- jsRepeated :: Lens' JSONSchema (Maybe Bool)
- jsReadOnly :: Lens' JSONSchema (Maybe Bool)
- jsEnumDescriptions :: Lens' JSONSchema [Text]
- jsDescription :: Lens' JSONSchema (Maybe Text)
- jsProperties :: Lens' JSONSchema (Maybe JSONSchemaProperties)
- data RestDescriptionSchemas
- restDescriptionSchemas :: HashMap Text JSONSchema -> RestDescriptionSchemas
- rdsAddtional :: Lens' RestDescriptionSchemas (HashMap Text JSONSchema)
- data JSONSchemaVariantMapItem
- jsonSchemaVariantMapItem :: JSONSchemaVariantMapItem
- jsvmiRef :: Lens' JSONSchemaVariantMapItem (Maybe Text)
- jsvmiTypeValue :: Lens' JSONSchemaVariantMapItem (Maybe Text)
- data RestDescriptionResources
- restDescriptionResources :: HashMap Text RestResource -> RestDescriptionResources
- rdrAddtional :: Lens' RestDescriptionResources (HashMap Text RestResource)
- data RestMethodMediaUploadProtocols
- restMethodMediaUploadProtocols :: RestMethodMediaUploadProtocols
- rmmupSimple :: Lens' RestMethodMediaUploadProtocols (Maybe RestMethodMediaUploadProtocolsSimple)
- rmmupResumable :: Lens' RestMethodMediaUploadProtocols (Maybe RestMethodMediaUploadProtocolsResumable)
- data JSONSchemaAnnotations
- jsonSchemaAnnotations :: JSONSchemaAnnotations
- jsaRequired :: Lens' JSONSchemaAnnotations [Text]
- data RestMethodParameters
- restMethodParameters :: HashMap Text JSONSchema -> RestMethodParameters
- rmpAddtional :: Lens' RestMethodParameters (HashMap Text JSONSchema)
- data RestMethodMediaUpload
- restMethodMediaUpload :: RestMethodMediaUpload
- rmmuProtocols :: Lens' RestMethodMediaUpload (Maybe RestMethodMediaUploadProtocols)
- rmmuAccept :: Lens' RestMethodMediaUpload [Text]
- rmmuMaxSize :: Lens' RestMethodMediaUpload (Maybe Text)
- data JSONSchemaProperties
- jsonSchemaProperties :: HashMap Text JSONSchema -> JSONSchemaProperties
- jspAddtional :: Lens' JSONSchemaProperties (HashMap Text JSONSchema)
- data RestMethodMediaUploadProtocolsResumable
- restMethodMediaUploadProtocolsResumable :: RestMethodMediaUploadProtocolsResumable
- rmmuprPath :: Lens' RestMethodMediaUploadProtocolsResumable (Maybe Text)
- rmmuprMultiPart :: Lens' RestMethodMediaUploadProtocolsResumable Bool
- data DirectoryList
- directoryList :: DirectoryList
- dlKind :: Lens' DirectoryList Text
- dlItems :: Lens' DirectoryList [DirectoryListItemsItem]
- dlDiscoveryVersion :: Lens' DirectoryList Text
- data RestMethodRequest
- restMethodRequest :: RestMethodRequest
- rRef :: Lens' RestMethodRequest (Maybe Text)
- rParameterName :: Lens' RestMethodRequest (Maybe Text)
Service Configuration
discoveryService :: Service Source
Default request referring to version v1
of the APIs Discovery Service. This contains the host and root path used as a starting point for constructing service requests.
API Declaration
type DiscoveryAPI = APIsListResource :<|> APIsGetRestResource Source
Represents the entirety of the methods and resources available for the APIs Discovery Service service.
Resources
discovery.apis.getRest
discovery.apis.list
Types
RestMethodResponse
data RestMethodResponse Source
The schema for the response.
See: restMethodResponse
smart constructor.
restMethodResponse :: RestMethodResponse Source
Creates a value of RestMethodResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RestDescriptionParameters
data RestDescriptionParameters Source
Common parameters that apply across all apis.
See: restDescriptionParameters
smart constructor.
restDescriptionParameters Source
Creates a value of RestDescriptionParameters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdpAddtional :: Lens' RestDescriptionParameters (HashMap Text JSONSchema) Source
Description of a single parameter.
RestMethod
data RestMethod Source
restMethod :: RestMethod Source
Creates a value of RestMethod
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmSupportsMediaDownload :: Lens' RestMethod (Maybe Bool) Source
Whether this method supports media downloads.
rmParameterOrder :: Lens' RestMethod [Text] Source
Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.
rmMediaUpload :: Lens' RestMethod (Maybe RestMethodMediaUpload) Source
Media upload parameters.
rmHTTPMethod :: Lens' RestMethod (Maybe Text) Source
HTTP method used by this method.
rmPath :: Lens' RestMethod (Maybe Text) Source
The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.
rmResponse :: Lens' RestMethod (Maybe RestMethodResponse) Source
The schema for the response.
rmSupportsMediaUpload :: Lens' RestMethod (Maybe Bool) Source
Whether this method supports media uploads.
rmScopes :: Lens' RestMethod [Text] Source
OAuth 2.0 scopes applicable to this method.
rmSupportsSubscription :: Lens' RestMethod (Maybe Bool) Source
Whether this method supports subscriptions.
rmParameters :: Lens' RestMethod (Maybe RestMethodParameters) Source
Details for all parameters in this method.
rmId :: Lens' RestMethod (Maybe Text) Source
A unique ID for this method. This property can be used to match methods between different versions of Discovery.
rmEtagRequired :: Lens' RestMethod (Maybe Bool) Source
Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.
rmUseMediaDownloadService :: Lens' RestMethod (Maybe Bool) Source
Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.
rmDescription :: Lens' RestMethod (Maybe Text) Source
Description of this method.
rmRequest :: Lens' RestMethod (Maybe RestMethodRequest) Source
The schema for the request.
RestResource
data RestResource Source
restResource :: RestResource Source
Creates a value of RestResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrResources :: Lens' RestResource (Maybe RestResourceResources) Source
Sub-resources on this resource.
rrMethods :: Lens' RestResource (Maybe RestResourceMethods) Source
Methods on this resource.
RestDescriptionAuthOAuth2Scopes
data RestDescriptionAuthOAuth2Scopes Source
Available OAuth 2.0 scopes.
See: restDescriptionAuthOAuth2Scopes
smart constructor.
restDescriptionAuthOAuth2Scopes Source
Creates a value of RestDescriptionAuthOAuth2Scopes
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdaoasAddtional :: Lens' RestDescriptionAuthOAuth2Scopes (HashMap Text RestDescriptionAuthOAuth2ScopesAdditional) Source
The scope value.
RestDescriptionMethods
data RestDescriptionMethods Source
API-level methods for this API.
See: restDescriptionMethods
smart constructor.
Creates a value of RestDescriptionMethods
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdmAddtional :: Lens' RestDescriptionMethods (HashMap Text RestMethod) Source
An individual method description.
DirectoryListItemsItem
directoryListItemsItem :: DirectoryListItemsItem Source
Creates a value of DirectoryListItemsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dliiDiscoveryLink :: Lens' DirectoryListItemsItem (Maybe Text) Source
A link to the discovery document.
dliiPreferred :: Lens' DirectoryListItemsItem (Maybe Bool) Source
True if this version is the preferred version to use.
dliiKind :: Lens' DirectoryListItemsItem Text Source
The kind for this response.
dliiIcons :: Lens' DirectoryListItemsItem (Maybe DirectoryListItemsItemIcons) Source
Links to 16x16 and 32x32 icons representing the API.
dliiVersion :: Lens' DirectoryListItemsItem (Maybe Text) Source
The version of the API.
dliiDocumentationLink :: Lens' DirectoryListItemsItem (Maybe Text) Source
A link to human readable documentation for the API.
dliiLabels :: Lens' DirectoryListItemsItem [Text] Source
Labels for the status of this API, such as labs or deprecated.
dliiDescription :: Lens' DirectoryListItemsItem (Maybe Text) Source
The description of this API.
dliiDiscoveryRestURL :: Lens' DirectoryListItemsItem (Maybe Text) Source
The URL for the discovery REST document.
DirectoryListItemsItemIcons
data DirectoryListItemsItemIcons Source
Links to 16x16 and 32x32 icons representing the API.
See: directoryListItemsItemIcons
smart constructor.
directoryListItemsItemIcons :: DirectoryListItemsItemIcons Source
Creates a value of DirectoryListItemsItemIcons
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RestResourceResources
data RestResourceResources Source
Sub-resources on this resource.
See: restResourceResources
smart constructor.
Creates a value of RestResourceResources
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrrAddtional :: Lens' RestResourceResources (HashMap Text RestResource) Source
Description for any sub-resources on this resource.
RestDescriptionAuthOAuth2
data RestDescriptionAuthOAuth2 Source
OAuth 2.0 authentication information.
See: restDescriptionAuthOAuth2
smart constructor.
restDescriptionAuthOAuth2 :: RestDescriptionAuthOAuth2 Source
Creates a value of RestDescriptionAuthOAuth2
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdaoaScopes :: Lens' RestDescriptionAuthOAuth2 (Maybe RestDescriptionAuthOAuth2Scopes) Source
Available OAuth 2.0 scopes.
RestDescriptionAuthOAuth2ScopesAdditional
data RestDescriptionAuthOAuth2ScopesAdditional Source
The scope value.
See: restDescriptionAuthOAuth2ScopesAdditional
smart constructor.
restDescriptionAuthOAuth2ScopesAdditional :: RestDescriptionAuthOAuth2ScopesAdditional Source
Creates a value of RestDescriptionAuthOAuth2ScopesAdditional
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdaoasaDescription :: Lens' RestDescriptionAuthOAuth2ScopesAdditional (Maybe Text) Source
Description of scope.
RestMethodMediaUploadProtocolsSimple
data RestMethodMediaUploadProtocolsSimple Source
Supports uploading as a single HTTP request.
See: restMethodMediaUploadProtocolsSimple
smart constructor.
restMethodMediaUploadProtocolsSimple :: RestMethodMediaUploadProtocolsSimple Source
Creates a value of RestMethodMediaUploadProtocolsSimple
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmmupsPath :: Lens' RestMethodMediaUploadProtocolsSimple (Maybe Text) Source
The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
rmmupsMultiPart :: Lens' RestMethodMediaUploadProtocolsSimple Bool Source
True if this endpoint supports upload multipart media.
RestDescriptionIcons
data RestDescriptionIcons Source
Links to 16x16 and 32x32 icons representing the API.
See: restDescriptionIcons
smart constructor.
restDescriptionIcons :: RestDescriptionIcons Source
Creates a value of RestDescriptionIcons
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
JSONSchemaVariant
data JSONSchemaVariant Source
In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
See: jsonSchemaVariant
smart constructor.
jsonSchemaVariant :: JSONSchemaVariant Source
Creates a value of JSONSchemaVariant
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsvDiscriminant :: Lens' JSONSchemaVariant (Maybe Text) Source
The name of the type discriminant property.
jsvMap :: Lens' JSONSchemaVariant [JSONSchemaVariantMapItem] Source
The map of discriminant value to schema to use for parsing..
RestResourceMethods
data RestResourceMethods Source
Methods on this resource.
See: restResourceMethods
smart constructor.
Creates a value of RestResourceMethods
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrmAddtional :: Lens' RestResourceMethods (HashMap Text RestMethod) Source
Description for any methods on this resource.
RestDescriptionAuth
data RestDescriptionAuth Source
Authentication information.
See: restDescriptionAuth
smart constructor.
restDescriptionAuth :: RestDescriptionAuth Source
Creates a value of RestDescriptionAuth
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdaOAuth2 :: Lens' RestDescriptionAuth (Maybe RestDescriptionAuthOAuth2) Source
OAuth 2.0 authentication information.
RestDescription
data RestDescription Source
restDescription :: RestDescription Source
Creates a value of RestDescription
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdEtag
rdSchemas
rdServicePath
rdBasePath
rdKind
rdExponentialBackoffDefault
rdAuth
rdIcons
rdBaseURL
rdProtocol
rdOwnerName
rdResources
rdOwnerDomain
rdBatchPath
rdMethods
rdName
rdPackagePath
rdFeatures
rdVersion
rdParameters
rdDocumentationLink
rdRootURL
rdId
rdCanonicalName
rdLabels
rdDiscoveryVersion
rdTitle
rdRevision
rdDescription
rdSchemas :: Lens' RestDescription (Maybe RestDescriptionSchemas) Source
The schemas for this API.
rdServicePath :: Lens' RestDescription (Maybe Text) Source
The base path for all REST requests.
rdBasePath :: Lens' RestDescription (Maybe Text) Source
- DEPRECATED
- The base path for REST requests.
rdKind :: Lens' RestDescription Text Source
The kind for this response.
rdExponentialBackoffDefault :: Lens' RestDescription (Maybe Bool) Source
Enable exponential backoff for suitable methods in the generated clients.
rdAuth :: Lens' RestDescription (Maybe RestDescriptionAuth) Source
Authentication information.
rdIcons :: Lens' RestDescription (Maybe RestDescriptionIcons) Source
Links to 16x16 and 32x32 icons representing the API.
rdProtocol :: Lens' RestDescription Text Source
The protocol described by this document.
rdOwnerName :: Lens' RestDescription (Maybe Text) Source
The name of the owner of this API. See ownerDomain.
rdResources :: Lens' RestDescription (Maybe RestDescriptionResources) Source
The resources in this API.
rdOwnerDomain :: Lens' RestDescription (Maybe Text) Source
The domain of the owner of this API. Together with the ownerName and a packagePath values, this can be used to generate a library for this API which would have a unique fully qualified name.
rdBatchPath :: Lens' RestDescription Text Source
The path for REST batch requests.
rdMethods :: Lens' RestDescription (Maybe RestDescriptionMethods) Source
API-level methods for this API.
rdPackagePath :: Lens' RestDescription (Maybe Text) Source
The package of the owner of this API. See ownerDomain.
rdFeatures :: Lens' RestDescription [Text] Source
A list of supported features for this API.
rdParameters :: Lens' RestDescription (Maybe RestDescriptionParameters) Source
Common parameters that apply across all apis.
rdDocumentationLink :: Lens' RestDescription (Maybe Text) Source
A link to human readable documentation for the API.
rdRootURL :: Lens' RestDescription (Maybe Text) Source
The root URL under which all API services live.
rdCanonicalName :: Lens' RestDescription (Maybe Text) Source
Indicates how the API name should be capitalized and split into various parts. Useful for generating pretty class names.
rdLabels :: Lens' RestDescription [Text] Source
Labels for the status of this API, such as labs or deprecated.
rdDiscoveryVersion :: Lens' RestDescription Text Source
Indicate the version of the Discovery API used to generate this doc.
rdRevision :: Lens' RestDescription (Maybe Text) Source
The version of this API.
rdDescription :: Lens' RestDescription (Maybe Text) Source
The description of this API.
JSONSchema
data JSONSchema Source
jsonSchema :: JSONSchema Source
Creates a value of JSONSchema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsAnnotations :: Lens' JSONSchema (Maybe JSONSchemaAnnotations) Source
Additional information about this property.
jsVariant :: Lens' JSONSchema (Maybe JSONSchemaVariant) Source
In a variant data type, the value of one property is used to determine how to interpret the entire entity. Its value must exist in a map of descriminant values to schema names.
jsLocation :: Lens' JSONSchema (Maybe Text) Source
Whether this parameter goes in the query or the path for REST requests.
jsRef :: Lens' JSONSchema (Maybe Text) Source
A reference to another schema. The value of this property is the "id" of another schema.
jsPattern :: Lens' JSONSchema (Maybe Text) Source
The regular expression this parameter must conform to. Uses Java 6 regex format: http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html
jsDefault :: Lens' JSONSchema (Maybe Text) Source
The default value of this property (if one exists).
jsFormat :: Lens' JSONSchema (Maybe Text) Source
An additional regular expression or key that helps constrain the value. For more details see: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
jsItems :: Lens' JSONSchema (Maybe JSONSchema) Source
If this is a schema for an array, this property is the schema for each element in the array.
jsRequired :: Lens' JSONSchema (Maybe Bool) Source
Whether the parameter is required.
jsAdditionalProperties :: Lens' JSONSchema (Maybe JSONSchema) Source
If this is a schema for an object, this property is the schema for any additional properties with dynamic keys on this object.
jsType :: Lens' JSONSchema (Maybe Text) Source
The value type for this schema. A list of values can be found here: http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
jsEnum :: Lens' JSONSchema [Text] Source
Values this parameter may take (if it is an enum).
jsRepeated :: Lens' JSONSchema (Maybe Bool) Source
Whether this parameter may appear multiple times.
jsReadOnly :: Lens' JSONSchema (Maybe Bool) Source
The value is read-only, generated by the service. The value cannot be modified by the client. If the value is included in a POST, PUT, or PATCH request, it is ignored by the service.
jsEnumDescriptions :: Lens' JSONSchema [Text] Source
The descriptions for the enums. Each position maps to the corresponding value in the "enum" array.
jsDescription :: Lens' JSONSchema (Maybe Text) Source
A description of this object.
jsProperties :: Lens' JSONSchema (Maybe JSONSchemaProperties) Source
If this is a schema for an object, list the schema for each property of this object.
RestDescriptionSchemas
data RestDescriptionSchemas Source
The schemas for this API.
See: restDescriptionSchemas
smart constructor.
Creates a value of RestDescriptionSchemas
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdsAddtional :: Lens' RestDescriptionSchemas (HashMap Text JSONSchema) Source
An individual schema description.
JSONSchemaVariantMapItem
jsonSchemaVariantMapItem :: JSONSchemaVariantMapItem Source
Creates a value of JSONSchemaVariantMapItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
RestDescriptionResources
data RestDescriptionResources Source
The resources in this API.
See: restDescriptionResources
smart constructor.
restDescriptionResources Source
Creates a value of RestDescriptionResources
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdrAddtional :: Lens' RestDescriptionResources (HashMap Text RestResource) Source
An individual resource description. Contains methods and sub-resources related to this resource.
RestMethodMediaUploadProtocols
data RestMethodMediaUploadProtocols Source
Supported upload protocols.
See: restMethodMediaUploadProtocols
smart constructor.
restMethodMediaUploadProtocols :: RestMethodMediaUploadProtocols Source
Creates a value of RestMethodMediaUploadProtocols
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmmupSimple :: Lens' RestMethodMediaUploadProtocols (Maybe RestMethodMediaUploadProtocolsSimple) Source
Supports uploading as a single HTTP request.
rmmupResumable :: Lens' RestMethodMediaUploadProtocols (Maybe RestMethodMediaUploadProtocolsResumable) Source
Supports the Resumable Media Upload protocol.
JSONSchemaAnnotations
data JSONSchemaAnnotations Source
Additional information about this property.
See: jsonSchemaAnnotations
smart constructor.
jsonSchemaAnnotations :: JSONSchemaAnnotations Source
Creates a value of JSONSchemaAnnotations
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsaRequired :: Lens' JSONSchemaAnnotations [Text] Source
A list of methods for which this property is required on requests.
RestMethodParameters
data RestMethodParameters Source
Details for all parameters in this method.
See: restMethodParameters
smart constructor.
Creates a value of RestMethodParameters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmpAddtional :: Lens' RestMethodParameters (HashMap Text JSONSchema) Source
Details for a single parameter in this method.
RestMethodMediaUpload
data RestMethodMediaUpload Source
Media upload parameters.
See: restMethodMediaUpload
smart constructor.
restMethodMediaUpload :: RestMethodMediaUpload Source
Creates a value of RestMethodMediaUpload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmmuProtocols :: Lens' RestMethodMediaUpload (Maybe RestMethodMediaUploadProtocols) Source
Supported upload protocols.
rmmuAccept :: Lens' RestMethodMediaUpload [Text] Source
MIME Media Ranges for acceptable media uploads to this method.
rmmuMaxSize :: Lens' RestMethodMediaUpload (Maybe Text) Source
Maximum size of a media upload, such as "1MB", "2GB" or "3TB".
JSONSchemaProperties
data JSONSchemaProperties Source
If this is a schema for an object, list the schema for each property of this object.
See: jsonSchemaProperties
smart constructor.
Creates a value of JSONSchemaProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jspAddtional :: Lens' JSONSchemaProperties (HashMap Text JSONSchema) Source
A single property of this object. The value is itself a JSON Schema object describing this property.
RestMethodMediaUploadProtocolsResumable
data RestMethodMediaUploadProtocolsResumable Source
Supports the Resumable Media Upload protocol.
See: restMethodMediaUploadProtocolsResumable
smart constructor.
restMethodMediaUploadProtocolsResumable :: RestMethodMediaUploadProtocolsResumable Source
Creates a value of RestMethodMediaUploadProtocolsResumable
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rmmuprPath :: Lens' RestMethodMediaUploadProtocolsResumable (Maybe Text) Source
The URI path to be used for upload. Should be used in conjunction with the basePath property at the api-level.
rmmuprMultiPart :: Lens' RestMethodMediaUploadProtocolsResumable Bool Source
True if this endpoint supports uploading multipart media.
DirectoryList
data DirectoryList Source
directoryList :: DirectoryList Source
Creates a value of DirectoryList
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dlKind :: Lens' DirectoryList Text Source
The kind for this response.
dlItems :: Lens' DirectoryList [DirectoryListItemsItem] Source
The individual directory entries. One entry per api/version pair.
dlDiscoveryVersion :: Lens' DirectoryList Text Source
Indicate the version of the Discovery API used to generate this doc.
RestMethodRequest
data RestMethodRequest Source
The schema for the request.
See: restMethodRequest
smart constructor.
restMethodRequest :: RestMethodRequest Source
Creates a value of RestMethodRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rParameterName :: Lens' RestMethodRequest (Maybe Text) Source
parameter name.