securitySchemes:
oAuth2ClientCredentials:
Type: oauth2
Flows:
clientCredentials:
tokenUrl: '{nrfApiRoot}/oauth2/token'
scopes:
nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API
schemas:
SpendingLimitContext:
Type: object
Properties:
supi:
Description: The Subscription Permanent Identifier (Supi) shall be present within the initial spending limit retrieval procedure (creation of a new individual subscription).
Reference: './TS29571_CommonData.yaml#/components/schemas/Supi'
gpsi:
Description: The Generic Public Subscription Identifier (Gpsi) may be present within the initial spending limit retrieval procedure (creation of a new individual subscription).
Reference: './TS29571_CommonData.yaml#/components/schemas/Gpsi'
policyCounterIds:
Type: array
Items:
Reference: '#/components/schemas/PolicyCounterId'
minItems: 1
Description: This is a list of policy counter identifier(s), which identifies policy counters maintained per subscriber within the CHF.
notifUri:
Description: This attribute identifies the recipient of spending limit notifications sent to the NF service consumer by the CHF. The notifUri shall be present within the initial spending limit retrieval procedure (creation of a new individual subscription). It may be present within the intermediate spending limit retrieval procedure (modification of an existing subscription).
Reference: './TS29571_CommonData.yaml#/components/schemas/Uri'
supportedFeatures:
Description: The list of supported features as described in subclause 5.8 shall be supplied by the NF service consumer in the POST request that request the creation of a spending limit report resource.
Reference: './TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
SpendingLimitStatus:
Type: object
Properties:
supi:
Description: The Subscription Permanent Identifier (Supi) shall be present within the callback notify service operation (notification of the status of subscribed policy counters).
Reference: './TS29571_CommonData.yaml#/components/schemas/Supi'
statusInfos:
Type: object
additionalProperties:
Reference: '#/components/schemas/PolicyCounterInfo'
minProperties: 1
Description: Status of the requested policy counters. The key of the map is the attribute "policyCounterId".
supportedFeatures:
Description: If the supportedFeatures is included in the request by the NF service consumer, it shall be supplied in the reply of the corresponding request by the CHF.
Reference: './TS29571_CommonData.yaml#/components/schemas/SupportedFeatures'
Required:
- statusInfos
PolicyCounterInfo:
Type: object
Properties:
policyCounterId:
Reference: '#/components/schemas/PolicyCounterId'
currentStatus:
Type: string
Description: Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.
penPolCounterStatuses:
Type: array
Items:
Reference: '#/components/schemas/PendingPolicyCounterStatus'
minItems: 1
Description: Provides the pending policy counter status.
Required:
- policyCounterId
- currentStatus
PendingPolicyCounterStatus:
Type: object
Properties:
policyCounterStatus:
Type: string
Description: Identifies the policy counter status applicable for a specific policy counter identified by the policyCounterId. The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP.
activationTime:
Description: Indicates the activation times per required policy counter.
Reference: './TS29571_CommonData.yaml#/components/schemas/DateTime'
Required:
- policyCounterStatus
- activationTime
PolicyCounterId:
Type: string
Description: Identifies a policy counter.
SubscriptionTerminationInfo:
Type: object
Properties:
supi:
Reference: './TS29571_CommonData.yaml#/components/schemas/Supi'
termCause:
Reference: '#/components/schemas/TerminationCause'
Required:
- supi
TerminationCause:
Type: string
enum:
- REMOVED_SUBSCRIBER