alibaba-cloud-sdk-go/services/cloudapi/describe_api_doc.go

package cloudapi

//Licensed under the Apache License, Version 2.0 (the "License");
//you may not use this file except in compliance with the License.
//You may obtain a copy of the License at
//
//http://www.apache.org/licenses/LICENSE-2.0
//
//Unless required by applicable law or agreed to in writing, software
//distributed under the License is distributed on an "AS IS" BASIS,
//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//See the License for the specific language governing permissions and
//limitations under the License.
//
// Code generated by Alibaba Cloud SDK Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is regenerated.

import (
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/requests"
	"github.com/aliyun/alibaba-cloud-sdk-go/sdk/responses"
)

func (client *Client) DescribeApiDoc(request *DescribeApiDocRequest) (response *DescribeApiDocResponse, err error) {
	response = CreateDescribeApiDocResponse()
	err = client.DoAction(request, response)
	return
}

func (client *Client) DescribeApiDocWithChan(request *DescribeApiDocRequest) (<-chan *DescribeApiDocResponse, <-chan error) {
	responseChan := make(chan *DescribeApiDocResponse, 1)
	errChan := make(chan error, 1)
	err := client.AddAsyncTask(func() {
		defer close(responseChan)
		defer close(errChan)
		response, err := client.DescribeApiDoc(request)
		responseChan <- response
		errChan <- err
	})
	if err != nil {
		errChan <- err
		close(responseChan)
		close(errChan)
	}
	return responseChan, errChan
}

func (client *Client) DescribeApiDocWithCallback(request *DescribeApiDocRequest, callback func(response *DescribeApiDocResponse, err error)) <-chan int {
	result := make(chan int, 1)
	err := client.AddAsyncTask(func() {
		var response *DescribeApiDocResponse
		var err error
		defer close(result)
		response, err = client.DescribeApiDoc(request)
		callback(response, err)
		result <- 1
	})
	if err != nil {
		defer close(result)
		callback(nil, err)
		result <- 0
	}
	return result
}

type DescribeApiDocRequest struct {
	*requests.RpcRequest
	StageName string `position:"Query" name:"StageName"`
	GroupId   string `position:"Query" name:"GroupId"`
	ApiId     string `position:"Query" name:"ApiId"`
}

type DescribeApiDocResponse struct {
	*responses.BaseResponse
	RequestId        string `json:"RequestId" xml:"RequestId"`
	RegionId         string `json:"RegionId" xml:"RegionId"`
	GroupId          string `json:"GroupId" xml:"GroupId"`
	GroupName        string `json:"GroupName" xml:"GroupName"`
	StageName        string `json:"StageName" xml:"StageName"`
	ApiId            string `json:"ApiId" xml:"ApiId"`
	ApiName          string `json:"ApiName" xml:"ApiName"`
	Description      string `json:"Description" xml:"Description"`
	Visibility       string `json:"Visibility" xml:"Visibility"`
	AuthType         string `json:"AuthType" xml:"AuthType"`
	ResultType       string `json:"ResultType" xml:"ResultType"`
	ResultSample     string `json:"ResultSample" xml:"ResultSample"`
	FailResultSample string `json:"FailResultSample" xml:"FailResultSample"`
	DeployedTime     string `json:"DeployedTime" xml:"DeployedTime"`
	RequestConfig    struct {
		RequestProtocol     string `json:"RequestProtocol" xml:"RequestProtocol"`
		RequestHttpMethod   string `json:"RequestHttpMethod" xml:"RequestHttpMethod"`
		RequestPath         string `json:"RequestPath" xml:"RequestPath"`
		BodyFormat          string `json:"BodyFormat" xml:"BodyFormat"`
		PostBodyDescription string `json:"PostBodyDescription" xml:"PostBodyDescription"`
		RequestMode         string `json:"RequestMode" xml:"RequestMode"`
	} `json:"RequestConfig" xml:"RequestConfig"`
	ErrorCodeSamples []struct {
		Code        string `json:"Code" xml:"Code"`
		Message     string `json:"Message" xml:"Message"`
		Description string `json:"Description" xml:"Description"`
	} `json:"ErrorCodeSamples" xml:"ErrorCodeSamples"`
	ResultDescriptions []struct {
		Id          string `json:"Id" xml:"Id"`
		Pid         string `json:"Pid" xml:"Pid"`
		HasChild    bool   `json:"HasChild" xml:"HasChild"`
		Key         string `json:"Key" xml:"Key"`
		Name        string `json:"Name" xml:"Name"`
		Mandatory   bool   `json:"Mandatory" xml:"Mandatory"`
		Type        string `json:"Type" xml:"Type"`
		Description string `json:"Description" xml:"Description"`
	} `json:"ResultDescriptions" xml:"ResultDescriptions"`
	RequestParameters []struct {
		ApiParameterName  string `json:"ApiParameterName" xml:"ApiParameterName"`
		Location          string `json:"Location" xml:"Location"`
		ParameterType     string `json:"ParameterType" xml:"ParameterType"`
		Required          string `json:"Required" xml:"Required"`
		DefaultValue      string `json:"DefaultValue" xml:"DefaultValue"`
		DemoValue         string `json:"DemoValue" xml:"DemoValue"`
		MaxValue          int64  `json:"MaxValue" xml:"MaxValue"`
		MinValue          int64  `json:"MinValue" xml:"MinValue"`
		MaxLength         int64  `json:"MaxLength" xml:"MaxLength"`
		MinLength         int64  `json:"MinLength" xml:"MinLength"`
		RegularExpression string `json:"RegularExpression" xml:"RegularExpression"`
		JsonScheme        string `json:"JsonScheme" xml:"JsonScheme"`
		EnumValue         string `json:"EnumValue" xml:"EnumValue"`
		DocShow           string `json:"DocShow" xml:"DocShow"`
		DocOrder          int    `json:"DocOrder" xml:"DocOrder"`
		Description       string `json:"Description" xml:"Description"`
	} `json:"RequestParameters" xml:"RequestParameters"`
}

func CreateDescribeApiDocRequest() (request *DescribeApiDocRequest) {
	request = &DescribeApiDocRequest{
		RpcRequest: &requests.RpcRequest{},
	}
	request.InitWithApiInfo("CloudAPI", "2016-07-14", "DescribeApiDoc", "", "")
	return
}

func CreateDescribeApiDocResponse() (response *DescribeApiDocResponse) {
	response = &DescribeApiDocResponse{
		BaseResponse: &responses.BaseResponse{},
	}
	return
}