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

   1 // Package loggingapi 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 loggingapi
   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 // Unsigned integer identifying a period of time in units of milliseconds.
  13 type DurationMs int
  14
  15 // Represents a set of Service API invocation logs to be stored in a CAPIF core function.
  16 type InvocationLog struct {
  17         // Identity information of the API exposing function requesting logging of service API invocations
  18         AefId string `json:"aefId"`
  19
  20         // Identity of the API invoker which invoked the service API
  21         ApiInvokerId string `json:"apiInvokerId"`
  22
  23         // Service API invocation log
  24         Logs []Log `json:"logs"`
  25
  26         // 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.
  27         SupportedFeatures *externalRef1.SupportedFeatures `json:"supportedFeatures,omitempty"`
  28 }
  29
  30 // Represents an individual service API invocation log entry.
  31 type Log struct {
  32         // String identifying the API invoked.
  33         ApiId string `json:"apiId"`
  34
  35         // Name of the API which was invoked, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.
  36         ApiName string `json:"apiName"`
  37
  38         // Version of the API which was invoked
  39         ApiVersion string `json:"apiVersion"`
  40
  41         // Represents the description of an API's interface.
  42         DestInterface *externalRef2.InterfaceDescription `json:"destInterface,omitempty"`
  43
  44         // It includes the node identifier (as defined in IETF RFC 7239 of all forwarding entities between the API invoker and the AEF, concatenated with comma and space, e.g. 192.0.2.43:80, unknown:_OBFport, 203.0.113.60
  45         FwdInterface *string `json:"fwdInterface,omitempty"`
  46
  47         // List of input parameters. Can be any value - string, number, boolean, array or object.
  48         InputParameters *interface{} `json:"inputParameters,omitempty"`
  49
  50         // Unsigned integer identifying a period of time in units of milliseconds.
  51         InvocationLatency *DurationMs `json:"invocationLatency,omitempty"`
  52
  53         // string with format "date-time" as defined in OpenAPI.
  54         InvocationTime *externalRef0.DateTime `json:"invocationTime,omitempty"`
  55
  56         // Possible values are - GET: HTTP GET method - POST: HTTP POST method - PUT: HTTP PUT method - PATCH: HTTP PATCH method - DELETE: HTTP DELETE method
  57         Operation *externalRef2.Operation `json:"operation,omitempty"`
  58
  59         // List of output parameters. Can be any value - string, number, boolean, array or object.
  60         OutputParameters *interface{} `json:"outputParameters,omitempty"`
  61
  62         // Possible values are - HTTP_1_1: HTTP version 1.1 - HTTP_2: HTTP version 2
  63         Protocol externalRef2.Protocol `json:"protocol"`
  64
  65         // Name of the specific resource invoked
  66         ResourceName string `json:"resourceName"`
  67
  68         // For HTTP protocol, it contains HTTP status code of the invocation
  69         Result string `json:"result"`
  70
  71         // Represents the description of an API's interface.
  72         SrcInterface *externalRef2.InterfaceDescription `json:"srcInterface,omitempty"`
  73
  74         // string providing an URI formatted according to IETF RFC 3986.
  75         Uri *externalRef0.Uri `json:"uri,omitempty"`
  76 }
  77
  78 // PostAefIdLogsJSONBody defines parameters for PostAefIdLogs.
  79 type PostAefIdLogsJSONBody InvocationLog
  80
  81 // PostAefIdLogsJSONRequestBody defines body for PostAefIdLogs for application/json ContentType.
  82 type PostAefIdLogsJSONRequestBody PostAefIdLogsJSONBody