enums in openapi file (986bdd88) · Commits · OCF / capif

services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/openapi/openapi.yaml

+7 −33

Changes for services/TS29222_CAPIF_API_Invoker_Management_API/api_invoker_management/openapi/openapi.yaml: 7 added lines, 33 removed lines.
Original line number	Diff line number	Diff line
		@@ -5431,14 +5431,10 @@ components:
		title: Resource
		type: object
		CommunicationType:
		anyOf:
		- enum:
		enum:
		- REQUEST_RESPONSE
		- SUBSCRIBE_NOTIFY
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a communication type of the resource or the custom operation.\
		\ \nPossible values are:\n- REQUEST_RESPONSE: The communication is of the\
		\ type request-response.\n- SUBSCRIBE_NOTIFY: The communication is of the\
		@@ -5479,32 +5475,24 @@ components:
		title: CustomOperation
		type: object
		Operation:
		anyOf:
		- enum:
		enum:
		- GET
		- POST
		- PUT
		- PATCH
		- DELETE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates an HTTP method. \nPossible values are:\n- GET: HTTP\
		\ GET method.\n- POST: HTTP POST method.\n- PUT: HTTP PUT method.\n- PATCH:\
		\ HTTP PATCH method.\n- DELETE: HTTP DELETE method.\n"
		title: Operation
		Protocol:
		anyOf:
		- enum:
		enum:
		- HTTP_1_1
		- HTTP_2
		- MQTT
		- WEBSOCKET
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a protocol and protocol version used by the API. \n\
		Possible values are:\n- HTTP_1_1: Indicates that the protocol is HTTP version\
		\ 1.1.\n- HTTP_2: Indicates that the protocol is HTTP version 2.\n- MQTT:\
		@@ -5512,30 +5500,22 @@ components:
		\ Indicates that the protocol is Websocket.\n"
		title: Protocol
		DataFormat:
		anyOf:
		- enum:
		enum:
		- JSON
		- XML
		- PROTOBUF3
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a data format. \nPossible values are:\n- JSON: Indicates\
		\ that the data format is JSON.\n- XML: Indicates that the data format is\
		\ Extensible Markup Language.\n- PROTOBUF3: Indicates that the data format\
		\ is Protocol buffers version 3.\n"
		title: DataFormat
		SecurityMethod:
		anyOf:
		- enum:
		enum:
		- PSK
		- PKI
		- OAUTH
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the security method. \nPossible values are:\n- PSK:\
		\ Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122.\n- PKI:\
		\ Security method 2 (Using PKI) as described in 3GPP TS 33.122.\n- OAUTH:\
		@@ -5846,15 +5826,11 @@ components:
		title: expTime
		type: string
		OAuthGrantType:
		anyOf:
		- enum:
		enum:
		- CLIENT_CREDENTIALS
		- AUTHORIZATION_CODE
		- AUTHORIZATION_CODE_WITH_PKCE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the supported authorization flow (e.g. client credentials\
		\ flow, authorization code flow, etc.) to the API invoker. \nPossible\
		\ values are:\n- CLIENT_CREDENTIALS: Indicate that the grant type is is client\
		@@ -6077,8 +6053,7 @@ components:
		title: GADShape
		type: object
		SupportedGADShapes:
		anyOf:
		- enum:
		enum:
		- POINT
		- POINT_UNCERTAINTY_CIRCLE
		- POINT_UNCERTAINTY_ELLIPSE
		@@ -6092,7 +6067,6 @@ components:
		- RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE
		- RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID
		type: string
		- type: string
		description: Indicates supported GAD shapes.
		title: SupportedGADShapes
		PointUncertaintyCircle:

services/TS29222_CAPIF_API_Provider_Management_API/api_provider_management/openapi/openapi.yaml

+1 −5

Changes for services/TS29222_CAPIF_API_Provider_Management_API/api_provider_management/openapi/openapi.yaml: 1 added line, 5 removed lines.
Original line number	Diff line number	Diff line
		@@ -617,15 +617,11 @@ components:
		title: APIProviderEnrolmentDetailsPatch
		type: object
		ApiProviderFuncRole:
		anyOf:
		- enum:
		enum:
		- AEF
		- APF
		- AMF
		type: string
		- description: \|
		This string provides forward-compatiblity with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the role (e.g. AEF, APF, etc.) of an API provider domain\
		\ function. \nPossible values are:\n- AEF: API provider function is API Exposing\
		\ Function.\n- APF: API provider function is API Publishing Function.\n- AMF:\

services/TS29222_CAPIF_Auditing_API/logs/openapi/openapi.yaml

+4 −20

Changes for services/TS29222_CAPIF_Auditing_API/logs/openapi/openapi.yaml: 4 added lines, 20 removed lines.
Original line number	Diff line number	Diff line
		@@ -323,16 +323,12 @@ components:
		title: DateTime
		type: string
		Protocol:
		anyOf:
		- enum:
		enum:
		- HTTP_1_1
		- HTTP_2
		- MQTT
		- WEBSOCKET
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a protocol and protocol version used by the API. \n\
		Possible values are:\n- HTTP_1_1: Indicates that the protocol is HTTP version\
		\ 1.1.\n- HTTP_2: Indicates that the protocol is HTTP version 2.\n- MQTT:\
		@@ -340,17 +336,13 @@ components:
		\ Indicates that the protocol is Websocket.\n"
		title: Protocol
		Operation:
		anyOf:
		- enum:
		enum:
		- GET
		- POST
		- PUT
		- PATCH
		- DELETE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates an HTTP method. \nPossible values are:\n- GET: HTTP\
		\ GET method.\n- POST: HTTP POST method.\n- PUT: HTTP PUT method.\n- PATCH:\
		\ HTTP PATCH method.\n- DELETE: HTTP DELETE method.\n"
		@@ -421,15 +413,11 @@ components:
		title: InterfaceDescription
		type: object
		SecurityMethod:
		anyOf:
		- enum:
		enum:
		- PSK
		- PKI
		- OAUTH
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the security method. \nPossible values are:\n- PSK:\
		\ Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122.\n- PKI:\
		\ Security method 2 (Using PKI) as described in 3GPP TS 33.122.\n- OAUTH:\
		@@ -755,15 +743,11 @@ components:
		title: Port
		type: integer
		OAuthGrantType:
		anyOf:
		- enum:
		enum:
		- CLIENT_CREDENTIALS
		- AUTHORIZATION_CODE
		- AUTHORIZATION_CODE_WITH_PKCE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the supported authorization flow (e.g. client credentials\
		\ flow, authorization code flow, etc.) to the API invoker. \nPossible\
		\ values are:\n- CLIENT_CREDENTIALS: Indicate that the grant type is is client\

services/TS29222_CAPIF_Discover_Service_API/service_apis/openapi/openapi.yaml

+7 −36

Changes for services/TS29222_CAPIF_Discover_Service_API/service_apis/openapi/openapi.yaml: 7 added lines, 36 removed lines.
Original line number	Diff line number	Diff line
		@@ -1240,14 +1240,9 @@ components:
		type: object
		CommunicationType:
		type: string
		anyOf:
		- enum:
		enum:
		- REQUEST_RESPONSE
		- SUBSCRIBE_NOTIFY
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a communication type of the resource or the custom operation.\
		\ \nPossible values are:\n- REQUEST_RESPONSE: The communication is of the\
		\ type request-response.\n- SUBSCRIBE_NOTIFY: The communication is of the\
		@@ -1255,16 +1250,11 @@ components:
		title: CommunicationType
		Protocol:
		type: string
		anyOf:
		- enum:
		enum:
		- HTTP_1_1
		- HTTP_2
		- MQTT
		- WEBSOCKET
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a protocol and protocol version used by the API. \n\
		Possible values are:\n- HTTP_1_1: Indicates that the protocol is HTTP version\
		\ 1.1.\n- HTTP_2: Indicates that the protocol is HTTP version 2.\n- MQTT:\
		@@ -1273,15 +1263,10 @@ components:
		title: Protocol
		DataFormat:
		type: string
		anyOf:
		- enum:
		enum:
		- JSON
		- XML
		- PROTOBUF3
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a data format. \nPossible values are:\n- JSON: Indicates\
		\ that the data format is JSON.\n- XML: Indicates that the data format is\
		\ Extensible Markup Language.\n- PROTOBUF3: Indicates that the data format\
		@@ -1413,15 +1398,11 @@ components:
		title: ServiceKpis
		type: object
		OAuthGrantType:
		anyOf:
		- enum:
		enum:
		- CLIENT_CREDENTIALS
		- AUTHORIZATION_CODE
		- AUTHORIZATION_CODE_WITH_PKCE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the supported authorization flow (e.g. client credentials\
		\ flow, authorization code flow, etc.) to the API invoker. \nPossible\
		\ values are:\n- CLIENT_CREDENTIALS: Indicate that the grant type is is client\
		@@ -2484,31 +2465,23 @@ components:
		title: CustomOperation
		type: object
		Operation:
		anyOf:
		- enum:
		enum:
		- GET
		- POST
		- PUT
		- PATCH
		- DELETE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates an HTTP method. \nPossible values are:\n- GET: HTTP\
		\ GET method.\n- POST: HTTP POST method.\n- PUT: HTTP PUT method.\n- PATCH:\
		\ HTTP PATCH method.\n- DELETE: HTTP DELETE method.\n"
		title: Operation
		SecurityMethod:
		anyOf:
		- enum:
		enum:
		- PSK
		- PKI
		- OAUTH
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the security method. \nPossible values are:\n- PSK:\
		\ Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122.\n- PKI:\
		\ Security method 2 (Using PKI) as described in 3GPP TS 33.122.\n- OAUTH:\
		@@ -2858,8 +2831,7 @@ components:
		title: GADShape
		type: object
		SupportedGADShapes:
		anyOf:
		- enum:
		enum:
		- POINT
		- POINT_UNCERTAINTY_CIRCLE
		- POINT_UNCERTAINTY_ELLIPSE
		@@ -2873,7 +2845,6 @@ components:
		- RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE
		- RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID
		type: string
		- type: string
		description: Indicates supported GAD shapes.
		title: SupportedGADShapes
		PointUncertaintyCircle:

services/TS29222_CAPIF_Events_API/capif_events/openapi/openapi.yaml

+13 −60

Changes for services/TS29222_CAPIF_Events_API/capif_events/openapi/openapi.yaml: 13 added lines, 60 removed lines.
Original line number	Diff line number	Diff line
		@@ -4322,8 +4322,7 @@ components:
		title: EventSubscriptionPatch
		type: object
		CAPIFEvent:
		anyOf:
		- enum:
		enum:
		- SERVICE_API_AVAILABLE
		- SERVICE_API_UNAVAILABLE
		- SERVICE_API_UPDATE
		@@ -4338,9 +4337,6 @@ components:
		- API_TOPOLOGY_HIDING_CREATED
		- API_TOPOLOGY_HIDING_REVOKED
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Describes the CAPIF event. \nPossible values are:\n- SERVICE_API_AVAILABLE:\n\
		\ Events related to the availability of service APIs after the service APIs\
		\ are\n published.\n- SERVICE_API_UNAVAILABLE:\n Events related to the unavailability\
		@@ -5481,14 +5477,10 @@ components:
		title: Resource
		type: object
		CommunicationType:
		anyOf:
		- enum:
		enum:
		- REQUEST_RESPONSE
		- SUBSCRIBE_NOTIFY
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a communication type of the resource or the custom operation.\
		\ \nPossible values are:\n- REQUEST_RESPONSE: The communication is of the\
		\ type request-response.\n- SUBSCRIBE_NOTIFY: The communication is of the\
		@@ -5529,32 +5521,24 @@ components:
		title: CustomOperation
		type: object
		Operation:
		anyOf:
		- enum:
		enum:
		- GET
		- POST
		- PUT
		- PATCH
		- DELETE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates an HTTP method. \nPossible values are:\n- GET: HTTP\
		\ GET method.\n- POST: HTTP POST method.\n- PUT: HTTP PUT method.\n- PATCH:\
		\ HTTP PATCH method.\n- DELETE: HTTP DELETE method.\n"
		title: Operation
		Protocol:
		anyOf:
		- enum:
		enum:
		- HTTP_1_1
		- HTTP_2
		- MQTT
		- WEBSOCKET
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a protocol and protocol version used by the API. \n\
		Possible values are:\n- HTTP_1_1: Indicates that the protocol is HTTP version\
		\ 1.1.\n- HTTP_2: Indicates that the protocol is HTTP version 2.\n- MQTT:\
		@@ -5562,30 +5546,22 @@ components:
		\ Indicates that the protocol is Websocket.\n"
		title: Protocol
		DataFormat:
		anyOf:
		- enum:
		enum:
		- JSON
		- XML
		- PROTOBUF3
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates a data format. \nPossible values are:\n- JSON: Indicates\
		\ that the data format is JSON.\n- XML: Indicates that the data format is\
		\ Extensible Markup Language.\n- PROTOBUF3: Indicates that the data format\
		\ is Protocol buffers version 3.\n"
		title: DataFormat
		SecurityMethod:
		anyOf:
		- enum:
		enum:
		- PSK
		- PKI
		- OAUTH
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the security method. \nPossible values are:\n- PSK:\
		\ Security method 1 (Using TLS-PSK) as described in 3GPP TS 33.122.\n- PKI:\
		\ Security method 2 (Using PKI) as described in 3GPP TS 33.122.\n- OAUTH:\
		@@ -6412,15 +6388,11 @@ components:
		title: Ipv6AddressRange
		type: object
		NotificationMethod:
		anyOf:
		- enum:
		enum:
		- PERIODIC
		- ONE_TIME
		- ON_EVENT_DETECTION
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API.
		type: string
		description: "Represents the notification methods that can be subscribed. \n\
		Possible values are:\n- PERIODIC\n- ONE_TIME\n- ON_EVENT_DETECTION\n"
		title: NotificationMethod
		@@ -6446,17 +6418,13 @@ components:
		title: SamplingRatio
		type: integer
		PartitioningCriteria:
		anyOf:
		- enum:
		enum:
		- TAC
		- SUBPLMN
		- GEOAREA
		- SNSSAI
		- DNN
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration but is not used to encode content defined in the present version of this API.
		type: string
		description: \|
		Possible values are:
		- "TAC": Type Allocation Code
		@@ -6466,16 +6434,11 @@ components:
		- "DNN": DNN
		title: PartitioningCriteria
		NotificationFlag:
		anyOf:
		- enum:
		enum:
		- ACTIVATE
		- DEACTIVATE
		- RETRIEVAL
		type: string
		- description: "This string provides forward-compatibility with future extensions\
		\ to the enumeration but is not used to encode content defined in the present\
		\ version of this API. \n"
		type: string
		description: "Possible values are:\n- ACTIVATE: The event notification is activated.\n\
		- DEACTIVATE: The event notification is deactivated and shall be muted. The\
		\ available\n event(s) shall be stored.\n- RETRIEVAL: The event notification\
		@@ -6496,24 +6459,20 @@ components:
		title: MutingExceptionInstructions
		type: object
		BufferedNotificationsAction:
		anyOf:
		- enum:
		enum:
		- SEND_ALL
		- DISCARD_ALL
		- DROP_OLD
		type: string
		- type: string
		description: \|
		Indicates the required action by the event producer NF on the buffered Notifications.
		title: BufferedNotificationsAction
		SubscriptionAction:
		anyOf:
		- enum:
		enum:
		- CLOSE
		- CONTINUE_WITH_MUTING
		- CONTINUE_WITHOUT_MUTING
		type: string
		- type: string
		description: \|
		Indicates the required action by the event producer NF on the event subscription if an exception occurs while the event is muted.
		title: SubscriptionAction
		@@ -6534,15 +6493,11 @@ components:
		title: MutingNotificationsSettings
		type: object
		OAuthGrantType:
		anyOf:
		- enum:
		enum:
		- CLIENT_CREDENTIALS
		- AUTHORIZATION_CODE
		- AUTHORIZATION_CODE_WITH_PKCE
		type: string
		- description: \|
		This string provides forward-compatibility with future extensions to the enumeration and is not used to encode content defined in the present version of this API.
		type: string
		description: "Indicates the supported authorization flow (e.g. client credentials\
		\ flow, authorization code flow, etc.) to the API invoker. \nPossible\
		\ values are:\n- CLIENT_CREDENTIALS: Indicate that the grant type is is client\
		@@ -6770,8 +6725,7 @@ components:
		title: GADShape
		type: object
		SupportedGADShapes:
		anyOf:
		- enum:
		enum:
		- POINT
		- POINT_UNCERTAINTY_CIRCLE
		- POINT_UNCERTAINTY_ELLIPSE
		@@ -6785,7 +6739,6 @@ components:
		- RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE
		- RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID
		type: string
		- type: string
		description: Indicates supported GAD shapes.
		title: SupportedGADShapes
		PointUncertaintyCircle: