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

   1 // Package invokermanagementapi 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 invokermanagementapi
   5
   6 import (
   7         externalRef0 "oransc.org/nonrtric/capifcore/internal/common29122"
   8         externalRef1 "oransc.org/nonrtric/capifcore/internal/common29571"
   9         externalRef2 "oransc.org/nonrtric/capifcore/internal/publishserviceapi"
  10 )
  11
  12 // Information about the API Invoker that requested to onboard
  13 type APIInvokerEnrolmentDetails struct {
  14         // API invoker ID assigned by the CAPIF core function to the API invoker while on-boarding the API invoker. Shall not be present in the HTTP POST request from the API invoker to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses.
  15         ApiInvokerId *string `json:"apiInvokerId,omitempty"`
  16
  17         // Generic information related to the API invoker such as details of the device or the application.
  18         ApiInvokerInformation *string `json:"apiInvokerInformation,omitempty"`
  19
  20         // The list of service APIs that the API Invoker is allowed to invoke
  21         ApiList *APIList `json:"apiList,omitempty"`
  22
  23         // string providing an URI formatted according to IETF RFC 3986.
  24         NotificationDestination externalRef0.Uri `json:"notificationDestination"`
  25
  26         // Represents on-boarding information of the API invoker.
  27         OnboardingInformation OnboardingInformation `json:"onboardingInformation"`
  28
  29         // 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.
  30         RequestTestNotification *bool `json:"requestTestNotification,omitempty"`
  31
  32         // 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.
  33         SupportedFeatures *externalRef1.SupportedFeatures `json:"supportedFeatures,omitempty"`
  34
  35         // Represents the configuration information for the delivery of notifications over Websockets.
  36         WebsockNotifConfig *externalRef0.WebsockNotifConfig `json:"websockNotifConfig,omitempty"`
  37 }
  38
  39 // Represents an API Invoker’s enrolment details to be updated.
  40 type APIInvokerEnrolmentDetailsPatch struct {
  41         // Generic information related to the API invoker such as details of the device or the application.
  42         ApiInvokerInformation *string `json:"apiInvokerInformation,omitempty"`
  43
  44         // The list of service APIs that the API Invoker is allowed to invoke
  45         ApiList *APIList `json:"apiList,omitempty"`
  46
  47         // string providing an URI formatted according to IETF RFC 3986.
  48         NotificationDestination *externalRef0.Uri `json:"notificationDestination,omitempty"`
  49
  50         // Represents on-boarding information of the API invoker.
  51         OnboardingInformation *OnboardingInformation `json:"onboardingInformation,omitempty"`
  52 }
  53
  54 // The list of service APIs that the API Invoker is allowed to invoke
  55 type APIList []externalRef2.ServiceAPIDescription
  56
  57 // Represents on-boarding information of the API invoker.
  58 type OnboardingInformation struct {
  59         // The API Invoker’s generic client certificate, provided by the CAPIF core function.
  60         ApiInvokerCertificate *string `json:"apiInvokerCertificate,omitempty"`
  61
  62         // The API Invoker’s public key
  63         ApiInvokerPublicKey string `json:"apiInvokerPublicKey"`
  64
  65         // The API Invoker’s onboarding secret, provided by the CAPIF core function.
  66         OnboardingSecret *string `json:"onboardingSecret,omitempty"`
  67 }
  68
  69 // Represents a notification of on-boarding or update result.
  70 type OnboardingNotification struct {
  71         // Information about the API Invoker that requested to onboard
  72         ApiInvokerEnrolmentDetails *APIInvokerEnrolmentDetails `json:"apiInvokerEnrolmentDetails,omitempty"`
  73
  74         // The list of service APIs that the API Invoker is allowed to invoke
  75         ApiList *APIList `json:"apiList,omitempty"`
  76
  77         // string providing an URI formatted according to IETF RFC 3986.
  78         ResourceLocation *externalRef0.Uri `json:"resourceLocation,omitempty"`
  79
  80         // Set to "true" indicate successful on-boarding. Otherwise set to "false"
  81         Result bool `json:"result"`
  82 }
  83
  84 // PostOnboardedInvokersJSONBody defines parameters for PostOnboardedInvokers.
  85 type PostOnboardedInvokersJSONBody APIInvokerEnrolmentDetails
  86
  87 // PutOnboardedInvokersOnboardingIdJSONBody defines parameters for PutOnboardedInvokersOnboardingId.
  88 type PutOnboardedInvokersOnboardingIdJSONBody APIInvokerEnrolmentDetails
  89
  90 // PostOnboardedInvokersJSONRequestBody defines body for PostOnboardedInvokers for application/json ContentType.
  91 type PostOnboardedInvokersJSONRequestBody PostOnboardedInvokersJSONBody
  92
  93 // PutOnboardedInvokersOnboardingIdJSONRequestBody defines body for PutOnboardedInvokersOnboardingId for application/json ContentType.
  94 type PutOnboardedInvokersOnboardingIdJSONRequestBody PutOnboardedInvokersOnboardingIdJSONBody