apigateway

Documentation

Overview

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_service_metadata_route.tmpl

AUTOGENERATED CODE DO NOT EDIT This file is automatically generated from /internal/codegen/templates/aws_api_routes.tmpl

Index

• func DiffMultiRestApis(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleRestApi(c *gin.Context, dao db.ReaderDAO)
• func GetApiGatewayMetadata(c *gin.Context)
• func GetRestApi(c *gin.Context, dao db.ReaderDAO)
• func GetRestApisMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListRestApis(c *gin.Context, dao db.ReaderDAO)
• type ListRestApisResponse

Functions

func DiffMultiRestApis

func DiffMultiRestApis(c *gin.Context, dao db.ReaderDAO)

DiffMultiRestApis godoc @Summary Diff RestApis @Description get a diff of RestApis between two points in time @Tags aws apigateway @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/apigateway/rest_apis [get]

func DiffSingleRestApi

func DiffSingleRestApi(c *gin.Context, dao db.ReaderDAO)

DiffSingleRestApi godoc @Summary Diff RestApi @Description get a diff of RestApi between two points in time @Tags aws apigateway @Produce json @Param start_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param start_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param start_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param end_report_date query string true "Which date to pull data from. Current date by default" Format(date) @Param end_time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param end_time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param id path string true "The id of the RestApi to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/apigateway/rest_apis/{id} [get]

func GetApiGatewayMetadata

func GetApiGatewayMetadata(c *gin.Context)

GetApiGatewayMetadata godoc @Summary Get ApiGateway Metadata @Description get a list of ApiGateway metadata @Tags aws apigateway @Produce json @Security ApiKeyAuth @Success 200 {array} routes.AwsServiceMetadata @Failure 400 @Router /metadata/aws/apigateway [get]

func GetRestApi

func GetRestApi(c *gin.Context, dao db.ReaderDAO)

GetRestApi godoc @Summary Get a specific RestApi @Description Get a specific RestApi by its Id @Tags aws apigateway @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param id path string true "The id of the RestApi to retrieve" @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Security ApiKeyAuth @Success 200 {object} apigateway.RestApi @Failure 400 @Failure 404 @Router /inventory/aws/apigateway/rest_apis/{id} [get]

func GetRestApisMetadata

func GetRestApisMetadata(c *gin.Context, dao db.ReaderDAO)

GetRestApisMetadata godoc @Summary Get RestApis Metadata @Description get a list of rest_apis metadata @Tags aws apigateway @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Security ApiKeyAuth @Success 200 {array} routes.AwsResourceMetadata @Failure 400 @Router /metadata/aws/apigateway/rest_apis [get]

func ListRestApis

func ListRestApis(c *gin.Context, dao db.ReaderDAO)

ListRestApis godoc @Summary List RestApis @Description get a list of rest_apis @Tags aws apigateway @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param account_id query string false "A specific account to pull data from. All accounts by default" @Param region query string false "A specific region to pull data from. All regions by default" @Param time_selection query string false "How to select the time range to pull data from. 'latest' by default" Enums(latest, before, after, at) @Param time_selection_reference query string false "The reference time to use when selecting the time range to pull data from. Only used when time_selection is 'before', 'after', or 'at'." Format(dateTime) @Param pagination_token query string false "A pagination token. If this is specified, the next set of results is retrieved. The pagination token is returned in the response." @Param max_results query int false "The maximum number of results to return. Default is 100" @Security ApiKeyAuth @Success 200 {object} ListRestApisResponse @Failure 400 @Router /inventory/aws/apigateway/rest_apis [get]

Types

type ListRestApisResponse

type ListRestApisResponse struct {
	RestApis        []*apigateway.RestApi `json:"rest_apis"`
	PaginationToken *string               `json:"pagination_token,omitempty"`
}