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 - SERVICE_API_AVAILABLE: Events related to the availability of service APIs after the service APIs are published. - SERVICE_API_UNAVAILABLE: Events related to the unavailability of service APIs after the service APIs are unpublished. - SERVICE_API_UPDATE: Events related to change in service API information. - API_INVOKER_ONBOARDED: Events related to API invoker onboarded to CAPIF. - API_INVOKER_OFFBOARDED: Events related to API invoker offboarded from CAPIF. - SERVICE_API_INVOCATION_SUCCESS: Events related to the successful invocation of service APIs. - SERVICE_API_INVOCATION_FAILURE: Events related to the failed invocation of service APIs. - ACCESS_CONTROL_POLICY_UPDATE: Events related to the update for the access control policy related to the service APIs. - ACCESS_CONTROL_POLICY_UNAVAILABLE: Events related to the unavailability of the access control policy related to the service APIs. - API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs. - API_INVOKER_UPDATED: Events related to API invoker profile updated to CAPIF. - 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. - 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.
  54 type CAPIFEvent string
  55
  56 // Represents a CAPIF event details.
  57 type CAPIFEventDetail struct {
  58         // Represents the extension for access control policies.
  59         AccCtrlPolList *AccessControlPolicyListExt `json:"accCtrlPolList,omitempty"`
  60
  61         // Identifier of the service API
  62         ApiIds *[]string `json:"apiIds,omitempty"`
  63
  64         // Identity of the API invoker
  65         ApiInvokerIds *[]string `json:"apiInvokerIds,omitempty"`
  66
  67         // Represents the routing rules information of a service API.
  68         ApiTopoHide *TopologyHiding `json:"apiTopoHide,omitempty"`
  69
  70         // Invocation logs.
  71         InvocationLogs *[]externalRef4.InvocationLog `json:"invocationLogs,omitempty"`
  72
  73         // Description of the service API as published by the APF.
  74         ServiceAPIDescriptions *[]externalRef5.ServiceAPIDescription `json:"serviceAPIDescriptions,omitempty"`
  75 }
  76
  77 // Represents a CAPIF event filter.
  78 type CAPIFEventFilter struct {
  79         // Identifier of the API exposing function
  80         AefIds *[]string `json:"aefIds,omitempty"`
  81
  82         // Identifier of the service API
  83         ApiIds *[]string `json:"apiIds,omitempty"`
  84
  85         // Identity of the API invoker
  86         ApiInvokerIds *[]string `json:"apiInvokerIds,omitempty"`
  87 }
  88
  89 // Represents an individual CAPIF Event notification.
  90 type EventNotification struct {
  91         // Represents a CAPIF event details.
  92         EventDetail *CAPIFEventDetail `json:"eventDetail,omitempty"`
  93
  94         // Possible values are - SERVICE_API_AVAILABLE: Events related to the availability of service APIs after the service APIs are published. - SERVICE_API_UNAVAILABLE: Events related to the unavailability of service APIs after the service APIs are unpublished. - SERVICE_API_UPDATE: Events related to change in service API information. - API_INVOKER_ONBOARDED: Events related to API invoker onboarded to CAPIF. - API_INVOKER_OFFBOARDED: Events related to API invoker offboarded from CAPIF. - SERVICE_API_INVOCATION_SUCCESS: Events related to the successful invocation of service APIs. - SERVICE_API_INVOCATION_FAILURE: Events related to the failed invocation of service APIs. - ACCESS_CONTROL_POLICY_UPDATE: Events related to the update for the access control policy related to the service APIs. - ACCESS_CONTROL_POLICY_UNAVAILABLE: Events related to the unavailability of the access control policy related to the service APIs. - API_INVOKER_AUTHORIZATION_REVOKED: Events related to the revocation of the authorization of API invokers to access the service APIs. - API_INVOKER_UPDATED: Events related to API invoker profile updated to CAPIF. - 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. - 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.
  95         Events CAPIFEvent `json:"events"`
  96
  97         // Identifier of the subscription resource to which the notification is related – CAPIF resource identifier
  98         SubscriptionId string `json:"subscriptionId"`
  99 }
 100
 101 // Represents an individual CAPIF Event Subscription resource.
 102 type EventSubscription struct {
 103         // Subscribed event filters
 104         EventFilters *[]CAPIFEventFilter `json:"eventFilters,omitempty"`
 105
 106         // Represents the type of reporting that the subscription requires.
 107         EventReq *externalRef1.ReportingInformation `json:"eventReq,omitempty"`
 108
 109         // Subscribed events
 110         Events []CAPIFEvent `json:"events"`
 111
 112         // string providing an URI formatted according to IETF RFC 3986.
 113         NotificationDestination externalRef2.Uri `json:"notificationDestination"`
 114
 115         // Set to true by Subscriber to request the CAPIF core function to send a test notification as defined in in subclause 7.6. Set to false or omitted otherwise.
 116         RequestTestNotification *bool `json:"requestTestNotification,omitempty"`
 117
 118         // 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.
 119         SupportedFeatures *externalRef3.SupportedFeatures `json:"supportedFeatures,omitempty"`
 120
 121         // Represents the configuration information for the delivery of notifications over Websockets.
 122         WebsockNotifConfig *externalRef2.WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
 123 }
 124
 125 // Represents the routing rules information of a service API.
 126 type TopologyHiding struct {
 127         ApiId        string                     `json:"apiId"`
 128         RoutingRules []externalRef6.RoutingRule `json:"routingRules"`
 129 }
 130
 131 // PostSubscriberIdSubscriptionsJSONBody defines parameters for PostSubscriberIdSubscriptions.
 132 type PostSubscriberIdSubscriptionsJSONBody EventSubscription
 133
 134 // PostSubscriberIdSubscriptionsJSONRequestBody defines body for PostSubscriberIdSubscriptions for application/json ContentType.
 135 type PostSubscriberIdSubscriptionsJSONRequestBody PostSubscriberIdSubscriptionsJSONBody