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

   1 // Package providermanagementapi 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 providermanagementapi
   5
   6 import (
   7         externalRef1 "oransc.org/nonrtric/capifcore/internal/common29571"
   8 )
   9
  10 // Defines values for ApiProviderFuncRole.
  11 const (
  12         ApiProviderFuncRoleAEF ApiProviderFuncRole = "AEF"
  13
  14         ApiProviderFuncRoleAMF ApiProviderFuncRole = "AMF"
  15
  16         ApiProviderFuncRoleAPF ApiProviderFuncRole = "APF"
  17 )
  18
  19 // Represents an API provider domain's enrolment details.
  20 type APIProviderEnrolmentDetails struct {
  21         // API provider domain ID assigned by the CAPIF core function to the API management function while registering the API provider domain. Shall not be present in the HTTP POST request from the API Management function to the CAPIF core function, to on-board itself. Shall be present in all other HTTP requests and responses.
  22         ApiProvDomId *string `json:"apiProvDomId,omitempty"`
  23
  24         // Generic information related to the API provider domain such as details of the API provider applications.
  25         ApiProvDomInfo *string `json:"apiProvDomInfo,omitempty"`
  26
  27         // A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure. When included by the CAPIF core function in the HTTP response message, it lists the API domain functions details that are registered or updated successfully.
  28         ApiProvFuncs *[]APIProviderFunctionDetails `json:"apiProvFuncs,omitempty"`
  29
  30         // Registration or update specific failure information of failed API provider domain function registrations.Shall be present in the HTTP response body if atleast one of the API provider domain function registration or update registration fails.
  31         FailReason *string `json:"failReason,omitempty"`
  32
  33         // Security information necessary for the CAPIF core function to validate the registration of the API provider domain. Shall be present in HTTP POST request from API management function to CAPIF core function for API provider domain registration.
  34         RegSec string `json:"regSec"`
  35
  36         // 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.
  37         SuppFeat *externalRef1.SupportedFeatures `json:"suppFeat,omitempty"`
  38 }
  39
  40 // Represents an API provider domain's enrolment details.
  41 type APIProviderEnrolmentDetailsPatch struct {
  42         // Generic information related to the API provider domain such as details of the API provider applications.
  43         ApiProvDomInfo *string `json:"apiProvDomInfo,omitempty"`
  44
  45         // A list of individual API provider domain functions details. When included by the API management function in the HTTP request message, it lists the API provider domain functions that the API management function intends to register/update in registration or update registration procedure.
  46         ApiProvFuncs *[]APIProviderFunctionDetails `json:"apiProvFuncs,omitempty"`
  47 }
  48
  49 // Represents API provider domain function's details.
  50 type APIProviderFunctionDetails struct {
  51         // API provider domain functionID assigned by the CAPIF core function to the API provider domain function while registering/updating the API provider domain. Shall not be present in the HTTP POST request from the API management function to the CAPIF core function, to register itself. Shall be present in all other HTTP requests and responses.
  52         ApiProvFuncId *string `json:"apiProvFuncId,omitempty"`
  53
  54         // Generic information related to the API provider domain function such as details of the API provider applications.
  55         ApiProvFuncInfo *string `json:"apiProvFuncInfo,omitempty"`
  56
  57         // Possible values are - AEF: API provider function is API Exposing Function. - APF: API provider function is API Publishing Function. - AMF: API Provider function is API Management Function.
  58         ApiProvFuncRole ApiProviderFuncRole `json:"apiProvFuncRole"`
  59
  60         // Represents registration information of an individual API provider domain function.
  61         RegInfo RegistrationInformation `json:"regInfo"`
  62 }
  63
  64 // Possible values are - AEF: API provider function is API Exposing Function. - APF: API provider function is API Publishing Function. - AMF: API Provider function is API Management Function.
  65 type ApiProviderFuncRole string
  66
  67 // Represents registration information of an individual API provider domain function.
  68 type RegistrationInformation struct {
  69         // API provider domain function's client certificate
  70         ApiProvCert *string `json:"apiProvCert,omitempty"`
  71
  72         // Public Key of API Provider domain function.
  73         ApiProvPubKey string `json:"apiProvPubKey"`
  74 }
  75
  76 // PostRegistrationsJSONBody defines parameters for PostRegistrations.
  77 type PostRegistrationsJSONBody APIProviderEnrolmentDetails
  78
  79 // PutRegistrationsRegistrationIdJSONBody defines parameters for PutRegistrationsRegistrationId.
  80 type PutRegistrationsRegistrationIdJSONBody APIProviderEnrolmentDetails
  81
  82 // PostRegistrationsJSONRequestBody defines body for PostRegistrations for application/json ContentType.
  83 type PostRegistrationsJSONRequestBody PostRegistrationsJSONBody
  84
  85 // PutRegistrationsRegistrationIdJSONRequestBody defines body for PutRegistrationsRegistrationId for application/json ContentType.
  86 type PutRegistrationsRegistrationIdJSONRequestBody PutRegistrationsRegistrationIdJSONBody