// The location information (e.g. civic address, GPS coordinates, data center ID) where the AEF providing the service API is located.
AefLocation *AefLocation `json:"aefLocation,omitempty"`
- // Possible values are - JSON: JavaScript Object Notation
+ // Possible values are:
+ // - JSON: JavaScript Object Notation
DataFormat *DataFormat `json:"dataFormat,omitempty"`
// Domain to which API belongs to
// Interface details
InterfaceDescriptions *[]InterfaceDescription `json:"interfaceDescriptions,omitempty"`
- // Possible values are - HTTP_1_1: HTTP version 1.1 - HTTP_2: HTTP version 2
+ // Possible values are:
+ // - HTTP_1_1: HTTP version 1.1
+ // - HTTP_2: HTTP version 2
Protocol *Protocol `json:"protocol,omitempty"`
// Security methods supported by the AEF
Versions []Version `json:"versions"`
}
-// Possible values are - REQUEST_RESPONSE: The communication is of the type request-response - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify
+// Possible values are:
+// - REQUEST_RESPONSE: The communication is of the type request-response
+// - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify
type CommunicationType string
// Represents the description of a custom operation.
type CustomOperation struct {
- // Possible values are - REQUEST_RESPONSE: The communication is of the type request-response - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify
+ // Possible values are:
+ // - REQUEST_RESPONSE: The communication is of the type request-response
+ // - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify
CommType CommunicationType `json:"commType"`
- // it is set as {custOpName} part of the URI structure for a custom operation without resource association as defined in subclause 4.4 of 3GPP TS 29.501.
+ // it is set as {custOpName} part of the URI structure for a custom operation without resource association as defined in clause 5.2.4 of 3GPP TS 29.122.
CustOpName string `json:"custOpName"`
// Text description of the custom operation
Operations *[]Operation `json:"operations,omitempty"`
}
-// Possible values are - JSON: JavaScript Object Notation
+// Possible values are:
+// - JSON: JavaScript Object Notation
type DataFormat string
// Represents the description of an API's interface.
SecurityMethods *[]SecurityMethod `json:"securityMethods,omitempty"`
}
-// Possible values are - GET: HTTP GET method - POST: HTTP POST method - PUT: HTTP PUT method - PATCH: HTTP PATCH method - DELETE: HTTP DELETE method
+// Possible values are:
+// - GET: HTTP GET method
+// - POST: HTTP POST method
+// - PUT: HTTP PUT method
+// - PATCH: HTTP PATCH method
+// - DELETE: HTTP DELETE method
type Operation string
-// Possible values are - HTTP_1_1: HTTP version 1.1 - HTTP_2: HTTP version 2
+// Possible values are:
+// - HTTP_1_1: HTTP version 1.1
+// - HTTP_2: HTTP version 2
type Protocol string
// Represents the published API path within the same CAPIF provider domain.
// Represents the API resource data.
type Resource struct {
- // Possible values are - REQUEST_RESPONSE: The communication is of the type request-response - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify
+ // Possible values are:
+ // - REQUEST_RESPONSE: The communication is of the type request-response
+ // - SUBSCRIBE_NOTIFY: The communication is of the type subscribe-notify
CommType CommunicationType `json:"commType"`
- // it is set as {custOpName} part of the URI structure for a custom operation associated with a resource as defined in subclause 4.4 of 3GPP TS 29.501.
+ // it is set as {custOpName} part of the URI structure for a custom operation associated with a resource as defined in clause 5.2.4 of 3GPP TS 29.122.
CustOpName *string `json:"custOpName,omitempty"`
// Text description of the API resource
// Resource name
ResourceName string `json:"resourceName"`
- // Relative URI of the API resource, it is set as {apiSpecificResourceUriPart} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.
+ // Relative URI of the API resource, it is set as {apiSpecificSuffixes} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
Uri string `json:"uri"`
}
-// Possible values are - PSK: Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122 - PKI: Security method 2 (Using PKI) as described in 3GPP TS 33.122 - OAUTH: Security method 3 (TLS with OAuth token) as described in 3GPP TS 33.122
+// Possible values are:
+// - PSK: Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122
+// - PKI: Security method 2 (Using PKI) as described in 3GPP TS 33.122
+// - OAUTH: Security method 3 (TLS with OAuth token) as described in 3GPP TS 33.122
type SecurityMethod string
// Represents the description of a service API as published by the APF.
// API identifier assigned by the CAPIF core function to the published service API. Shall not be present in the HTTP POST request from the API publishing function to the CAPIF core function. Shall be present in the HTTP POST response from the CAPIF core function to the API publishing function and in the HTTP GET response from the CAPIF core function to the API invoker (discovery API).
ApiId *string `json:"apiId,omitempty"`
- // API name, it is set as {apiName} part of the URI structure as defined in subclause 4.4 of 3GPP TS 29.501.
+ // API name, it is set as {apiName} part of the URI structure as defined in clause 5.2.4 of 3GPP TS 29.122.
ApiName string `json:"apiName"`
// 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.
Resources *[]Resource `json:"resources,omitempty"`
}
-// Identification of the API publishing function.
-type ApfId string
-
-// String identifying an individual published service API.
-type ServiceApiId string
-
// PostApfIdServiceApisJSONBody defines parameters for PostApfIdServiceApis.
type PostApfIdServiceApisJSONBody ServiceAPIDescription
Code Review / nonrtric / plt / sme.git / blobdiff