internal/discoverserviceapi/discoverserviceapi-types.gen.go

   1 // Package discoverserviceapi 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 discoverserviceapi
   5
   6 import (
   7         externalRef1 "oransc.org/nonrtric/sme/internal/common29571"
   8         externalRef2 "oransc.org/nonrtric/sme/internal/publishserviceapi"
   9 )
  10
  11 // Represents a list of APIs currently registered in the CAPIF core function and satisfying a number of filter criteria provided by the API consumer.
  12 type DiscoveredAPIs struct {
  13         // Description of the service API as published by the service. Each service API description shall include AEF profiles matching the filter criteria.
  14         ServiceAPIDescriptions *[]externalRef2.ServiceAPIDescription `json:"serviceAPIDescriptions,omitempty"`
  15 }
  16
  17 // GetAllServiceAPIsParams defines parameters for GetAllServiceAPIs.
  18 type GetAllServiceAPIsParams struct {
  19         // String identifying the API invoker assigned by the CAPIF core function. It also represents the CCF identifier in the CAPIF-6/6e interface.
  20         ApiInvokerId string `json:"api-invoker-id"`
  21
  22         // API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.
  23         ApiName *string `json:"api-name,omitempty"`
  24
  25         // API major version the URI (e.g. v1).
  26         ApiVersion *string `json:"api-version,omitempty"`
  27
  28         // Communication type used by the API (e.g. REQUEST_RESPONSE).
  29         CommType *externalRef2.CommunicationType `json:"comm-type,omitempty"`
  30
  31         // Protocol used by the API.
  32         Protocol *externalRef2.Protocol `json:"protocol,omitempty"`
  33
  34         // AEF identifer.
  35         AefId *string `json:"aef-id,omitempty"`
  36
  37         // Data formats used by the API (e.g. serialization protocol JSON used).
  38         DataFormat *externalRef2.DataFormat `json:"data-format,omitempty"`
  39
  40         // The service API category to which the service API belongs to.
  41         ApiCat *string `json:"api-cat,omitempty"`
  42
  43         // Features supported by the NF consumer for the CAPIF Discover Service API.
  44         SupportedFeatures *externalRef1.SupportedFeatures `json:"supported-features,omitempty"`
  45
  46         // Features supported by the discovered service API indicated by api-name parameter. This may only be present if api-name query parameter is present.
  47         ApiSupportedFeatures *externalRef1.SupportedFeatures `json:"api-supported-features,omitempty"`
  48 }