apigatewayv2

Documentation

Overview

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

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

Index

• func DiffMultiApis(c *gin.Context, dao db.ReaderDAO)
• func DiffSingleApi(c *gin.Context, dao db.ReaderDAO)
• func GetApi(c *gin.Context, dao db.ReaderDAO)
• func GetApiGatewayV2Metadata(c *gin.Context)
• func GetApisMetadata(c *gin.Context, dao db.ReaderDAO)
• func ListApis(c *gin.Context, dao db.ReaderDAO)
• type ListApisResponse

Functions

func DiffMultiApis

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

DiffMultiApis godoc @Summary Diff Apis @Description get a diff of Apis between two points in time @Tags aws apigatewayv2 @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/apigatewayv2/apis [get]

func DiffSingleApi

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

DiffSingleApi godoc @Summary Diff Api @Description get a diff of Api between two points in time @Tags aws apigatewayv2 @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 api_id path string true "The api_id of the Api to retrieve" @Security ApiKeyAuth @Success 200 {array} routes.Diff @Failure 400 @Router /diff/aws/apigatewayv2/apis/{api_id} [get]

func GetApi

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

GetApi godoc @Summary Get a specific Api @Description Get a specific Api by its ApiId @Tags aws apigatewayv2 @Produce json @Param report_date query string false "Which date to pull data from. Current date by default" Format(date) @Param api_id path string true "The api_id of the Api 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} apigatewayv2.Api @Failure 400 @Failure 404 @Router /inventory/aws/apigatewayv2/apis/{api_id} [get]

func GetApiGatewayV2Metadata

func GetApiGatewayV2Metadata(c *gin.Context)

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

func GetApisMetadata

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

GetApisMetadata godoc @Summary Get Apis Metadata @Description get a list of apis metadata @Tags aws apigatewayv2 @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/apigatewayv2/apis [get]

func ListApis

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

ListApis godoc @Summary List Apis @Description get a list of apis @Tags aws apigatewayv2 @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} ListApisResponse @Failure 400 @Router /inventory/aws/apigatewayv2/apis [get]

Types

type ListApisResponse

type ListApisResponse struct {
	Apis            []*apigatewayv2.Api `json:"apis"`
	PaginationToken *string             `json:"pagination_token,omitempty"`
}