internal/accesscontrolpolicyapi/accesscontrolpolicyapi-types.gen.go

   1 // Package accesscontrolpolicyapi provides primitives to interact with the openapi HTTP API.
   2 //
   3 // Code generated by github.com/deepmap/oapi-codegen version v1.10.1 DO NOT EDIT.
   4 package accesscontrolpolicyapi
   5
   6 import (
   7         externalRef0 "oransc.org/nonrtric/sme/internal/common29122"
   8         externalRef1 "oransc.org/nonrtric/sme/internal/common29571"
   9 )
  10
  11 // Represents the access control policy list for a published service API.
  12 type AccessControlPolicyList struct {
  13         // Policy of each API invoker.
  14         ApiInvokerPolicies *[]ApiInvokerPolicy `json:"apiInvokerPolicies,omitempty"`
  15 }
  16
  17 // Represents the policy of an API Invoker.
  18 type ApiInvokerPolicy struct {
  19         // The time ranges during which the invocations are allowed on the service API by the API invoker.
  20         AllowedInvocationTimeRangeList *[]TimeRangeList `json:"allowedInvocationTimeRangeList,omitempty"`
  21
  22         // Invocations per second allowed on the service API by the API invoker.
  23         AllowedInvocationsPerSecond *int `json:"allowedInvocationsPerSecond,omitempty"`
  24
  25         // Total number of invocations allowed on the service API by the API invoker.
  26         AllowedTotalInvocations *int `json:"allowedTotalInvocations,omitempty"`
  27
  28         // API invoker ID assigned by the CAPIF core function
  29         ApiInvokerId string `json:"apiInvokerId"`
  30 }
  31
  32 // Represents the time range during which the invocation of a service API is allowed by the API invoker.
  33 type TimeRangeList struct {
  34         // string with format "date-time" as defined in OpenAPI.
  35         StartTime *externalRef0.DateTime `json:"startTime,omitempty"`
  36
  37         // string with format "date-time" as defined in OpenAPI.
  38         StopTime *externalRef0.DateTime `json:"stopTime,omitempty"`
  39 }
  40
  41 // GetAccessControlPolicyListServiceApiIdParams defines parameters for GetAccessControlPolicyListServiceApiId.
  42 type GetAccessControlPolicyListServiceApiIdParams struct {
  43         // Identifier of the AEF
  44         AefId string `json:"aef-id"`
  45
  46         // Identifier of the API invoker
  47         ApiInvokerId *string `json:"api-invoker-id,omitempty"`
  48
  49         // To filter irrelevant responses related to unsupported features
  50         SupportedFeatures *externalRef1.SupportedFeatures `json:"supported-features,omitempty"`
  51 }