capifcore/internal/eventsapi/eventsapi-types.gen.go

   1 // Package eventsapi 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 eventsapi
   5
   6 import (
   7         externalRef0 "oransc.org/nonrtric/capifcore/internal/accesscontrolpolicyapi"
   8         externalRef1 "oransc.org/nonrtric/capifcore/internal/common"
   9         externalRef2 "oransc.org/nonrtric/capifcore/internal/common29122"
  10         externalRef3 "oransc.org/nonrtric/capifcore/internal/common29571"
  11         externalRef4 "oransc.org/nonrtric/capifcore/internal/loggingapi"
  12         externalRef5 "oransc.org/nonrtric/capifcore/internal/publishserviceapi"
  13         externalRef6 "oransc.org/nonrtric/capifcore/internal/routinginfoapi"
  14 )
  15
  16 // Defines values for CAPIFEvent.
  17 const (
  18         CAPIFEventACCESSCONTROLPOLICYUNAVAILABLE CAPIFEvent = "ACCESS_CONTROL_POLICY_UNAVAILABLE"
  19
  20         CAPIFEventACCESSCONTROLPOLICYUPDATE CAPIFEvent = "ACCESS_CONTROL_POLICY_UPDATE"
  21
  22         CAPIFEventAPIINVOKERAUTHORIZATIONREVOKED CAPIFEvent = "API_INVOKER_AUTHORIZATION_REVOKED"
  23
  24         CAPIFEventAPIINVOKEROFFBOARDED CAPIFEvent = "API_INVOKER_OFFBOARDED"
  25
  26         CAPIFEventAPIINVOKERONBOARDED CAPIFEvent = "API_INVOKER_ONBOARDED"
  27
  28         CAPIFEventAPIINVOKERUPDATED CAPIFEvent = "API_INVOKER_UPDATED"
  29
  30         CAPIFEventAPITOPOLOGYHIDINGCREATED CAPIFEvent = "API_TOPOLOGY_HIDING_CREATED"
  31
  32         CAPIFEventAPITOPOLOGYHIDINGREVOKED CAPIFEvent = "API_TOPOLOGY_HIDING_REVOKED"
  33
  34         CAPIFEventSERVICEAPIAVAILABLE CAPIFEvent = "SERVICE_API_AVAILABLE"
  35
  36         CAPIFEventSERVICEAPIINVOCATIONFAILURE CAPIFEvent = "SERVICE_API_INVOCATION_FAILURE"
  37
  38         CAPIFEventSERVICEAPIINVOCATIONSUCCESS CAPIFEvent = "SERVICE_API_INVOCATION_SUCCESS"
  39
  40         CAPIFEventSERVICEAPIUNAVAILABLE CAPIFEvent = "SERVICE_API_UNAVAILABLE"
  41
  42         CAPIFEventSERVICEAPIUPDATE CAPIFEvent = "SERVICE_API_UPDATE"
  43 )
  44
  45 // AccessControlPolicyListExt defines model for AccessControlPolicyListExt.
  46 type AccessControlPolicyListExt struct {
  47         // Embedded struct due to allOf(TS29222_CAPIF_Access_Control_Policy_API.yaml#/components/schemas/AccessControlPolicyList)
  48         externalRef0.AccessControlPolicyList `yaml:",inline"`
  49         // Embedded fields due to inline allOf schema
  50         ApiId *string `json:"apiId,omitempty"`
  51 }
  52
  53 // Possible values are:
  54 // - SERVICE_API_AVAILABLE: Events related to the availability of service APIs after the service APIs are published.
  55 // - SERVICE_API_UNAVAILABLE: Events related to the unavailability of service APIs after the service APIs are unpublished.
  56 // - SERVICE_API_UPDATE: Events related to change in service API information.
  57 // - API_INVOKER_ONBOARDED: Events related to API invoker onboarded to CAPIF.
  58 // - API_INVOKER_OFFBOARDED: Events related to API invoker offboarded from CAPIF.
  59 // - SERVICE_API_INVOCATION_SUCCESS: Events related to the successful invocation of service APIs.
  60 // - SERVICE_API_INVOCATION_FAILURE: Events related to the failed invocation of service APIs.
  61 // - ACCESS_CONTROL_POLICY_UPDATE: Events related to the update for the access control policy related to the service APIs.
  62 // - ACCESS_CONTROL_POLICY_UNAVAILABLE: Events related to the unavailability of the access control policy related to the service APIs.
  63 // - API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs.
  64 // - API_INVOKER_UPDATED: Events related to API invoker profile updated to CAPIF.
  65 // - API_TOPOLOGY_HIDING_CREATED: Events related to the creation or update of the API topology hiding information of the service APIs after the service APIs are published.
  66 // - API_TOPOLOGY_HIDING_REVOKED: Events related to the revocation of the API topology hiding information of the service APIs after the service APIs are unpublished.
  67 type CAPIFEvent string
  68
  69 // Represents a CAPIF event details.
  70 type CAPIFEventDetail struct {
  71         // Represents the extension for access control policies.
  72         AccCtrlPolList *AccessControlPolicyListExt `json:"accCtrlPolList,omitempty"`
  73
  74         // Identifier of the service API
  75         ApiIds *[]string `json:"apiIds,omitempty"`
  76
  77         // Identity of the API invoker
  78         ApiInvokerIds *[]string `json:"apiInvokerIds,omitempty"`
  79
  80         // Represents the routing rules information of a service API.
  81         ApiTopoHide *TopologyHiding `json:"apiTopoHide,omitempty"`
  82
  83         // Invocation logs.
  84         InvocationLogs *[]externalRef4.InvocationLog `json:"invocationLogs,omitempty"`
  85
  86         // Description of the service API as published by the APF.
  87         ServiceAPIDescriptions *[]externalRef5.ServiceAPIDescription `json:"serviceAPIDescriptions,omitempty"`
  88 }
  89
  90 // Represents a CAPIF event filter.
  91 type CAPIFEventFilter struct {
  92         // Identifier of the API exposing function
  93         AefIds *[]string `json:"aefIds,omitempty"`
  94
  95         // Identifier of the service API
  96         ApiIds *[]string `json:"apiIds,omitempty"`
  97
  98         // Identity of the API invoker
  99         ApiInvokerIds *[]string `json:"apiInvokerIds,omitempty"`
 100 }
 101
 102 // Represents an individual CAPIF Event notification.
 103 type EventNotification struct {
 104         // Represents a CAPIF event details.
 105         EventDetail *CAPIFEventDetail `json:"eventDetail,omitempty"`
 106
 107         // Possible values are:
 108         // - SERVICE_API_AVAILABLE: Events related to the availability of service APIs after the service APIs are published.
 109         // - SERVICE_API_UNAVAILABLE: Events related to the unavailability of service APIs after the service APIs are unpublished.
 110         // - SERVICE_API_UPDATE: Events related to change in service API information.
 111         // - API_INVOKER_ONBOARDED: Events related to API invoker onboarded to CAPIF.
 112         // - API_INVOKER_OFFBOARDED: Events related to API invoker offboarded from CAPIF.
 113         // - SERVICE_API_INVOCATION_SUCCESS: Events related to the successful invocation of service APIs.
 114         // - SERVICE_API_INVOCATION_FAILURE: Events related to the failed invocation of service APIs.
 115         // - ACCESS_CONTROL_POLICY_UPDATE: Events related to the update for the access control policy related to the service APIs.
 116         // - ACCESS_CONTROL_POLICY_UNAVAILABLE: Events related to the unavailability of the access control policy related to the service APIs.
 117         // - API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs.
 118         // - API_INVOKER_UPDATED: Events related to API invoker profile updated to CAPIF.
 119         // - API_TOPOLOGY_HIDING_CREATED: Events related to the creation or update of the API topology hiding information of the service APIs after the service APIs are published.
 120         // - API_TOPOLOGY_HIDING_REVOKED: Events related to the revocation of the API topology hiding information of the service APIs after the service APIs are unpublished.
 121         Events CAPIFEvent `json:"events"`
 122
 123         // Identifier of the subscription resource to which the notification is related – CAPIF resource identifier
 124         SubscriptionId string `json:"subscriptionId"`
 125 }
 126
 127 // Represents an individual CAPIF Event Subscription resource.
 128 type EventSubscription struct {
 129         // Subscribed event filters
 130         EventFilters *[]CAPIFEventFilter `json:"eventFilters,omitempty"`
 131
 132         // Represents the type of reporting that the subscription requires.
 133         EventReq *externalRef1.ReportingInformation `json:"eventReq,omitempty"`
 134
 135         // Subscribed events
 136         Events []CAPIFEvent `json:"events"`
 137
 138         // string providing an URI formatted according to IETF RFC 3986.
 139         NotificationDestination externalRef2.Uri `json:"notificationDestination"`
 140
 141         // Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in clause 7.6. Set to false or omitted otherwise.
 142         RequestTestNotification *bool `json:"requestTestNotification,omitempty"`
 143
 144         // A string used to indicate the features supported by an API that is used as defined in clause  6.6 in 3GPP TS 29.500. The string shall contain a bitmask indicating supported features in  hexadecimal representation Each character in the string shall take a value of "0" to "9",  "a" to "f" or "A" to "F" and shall represent the support of 4 features as described in  table 5.2.2-3. The most significant character representing the highest-numbered features shall  appear first in the string, and the character representing features 1 to 4 shall appear last  in the string. The list of features and their numbering (starting with 1) are defined  separately for each API. If the string contains a lower number of characters than there are  defined features for an API, all features that would be represented by characters that are not  present in the string are not supported.
 145         SupportedFeatures *externalRef3.SupportedFeatures `json:"supportedFeatures,omitempty"`
 146
 147         // Represents the configuration information for the delivery of notifications over Websockets.
 148         WebsockNotifConfig *externalRef2.WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
 149 }
 150
 151 // Represents the routing rules information of a service API.
 152 type TopologyHiding struct {
 153         ApiId        string                     `json:"apiId"`
 154         RoutingRules []externalRef6.RoutingRule `json:"routingRules"`
 155 }
 156
 157 // PostSubscriberIdSubscriptionsJSONBody defines parameters for PostSubscriberIdSubscriptions.
 158 type PostSubscriberIdSubscriptionsJSONBody EventSubscription
 159
 160 // PostSubscriberIdSubscriptionsJSONRequestBody defines body for PostSubscriberIdSubscriptions for application/json ContentType.
 161 type PostSubscriberIdSubscriptionsJSONRequestBody PostSubscriberIdSubscriptionsJSONBody