Nchf_SpendingLimitControl_Callbacks

OpenAPI

OpenAPI Version: 3.0.0

Info


Description: Spending Limit Control Service API Callbacks 
Version: "1.0.0" 
Title: Nchf_SpendingLimitControl Callbacks

Servers


  URL: 'http://{apiRoot}/' 
  Variables: 
    API Root: 
      Default: https://example.com 
      Description: apiRoot as defined in subclause subclause 4.4 of 3GPP TS 29.501

Security


- {} 
- oAuth2ClientCredentials: 
  - nchf-spendinglimitcontrol

Paths

/npcf/callbacks/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}/notify


  Method: Post 
 
    Parameters: 
    - in: path 
      name: subscriptionId 
      Description: Identifies an individual spending limit retrieval subscription. 
      Required/Optional: true 
      Schema: 
        Type: string 
    Request Body: 
      Required/Optional: true 
      Content: 
        Application/JSON: 
          Schema: 
            Reference: './TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/SpendingLimitStatus' 
 
    Responses: 
      '204': 
        Description: No Content, Notification was succesfull 
      '400': 
        Reference: './TS29571_CommonData.yaml#/components/responses/400' 
      '401': 
        Reference: './TS29571_CommonData.yaml#/components/responses/401' 
      '403': 
        Reference: './TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: './TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: './TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: './TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: './TS29571_CommonData.yaml#/components/responses/415' 
      '429': 
        Reference: './TS29571_CommonData.yaml#/components/responses/429' 
      '500': 
        Reference: './TS29571_CommonData.yaml#/components/responses/500' 
      '503': 
        Reference: './TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: './TS29571_CommonData.yaml#/components/responses/default'

/npcf/callbacks/nchf-spendinglimitcontrol/v1/subscriptions/{subscriptionId}/terminate


  Method: Post 
 
    Parameters: 
    - in: path 
      name: subscriptionId 
      Description: Identifies an individual spending limit retrieval subscription. 
      Required/Optional: true 
      Schema: 
        Type: string 
    Request Body: 
      Required/Optional: true 
      Content: 
        Application/JSON: 
          Schema: 
            Reference: './TS29594_Nchf_SpendingLimitControl.yaml#/components/schemas/SubscriptionTerminationInfo' 
 
    Responses: 
      '204': 
        Description: No Content, Notification was succesfull 
      '400': 
        Reference: './TS29571_CommonData.yaml#/components/responses/400' 
      '401': 
        Reference: './TS29571_CommonData.yaml#/components/responses/401' 
      '403': 
        Reference: './TS29571_CommonData.yaml#/components/responses/403' 
      '404': 
        Reference: './TS29571_CommonData.yaml#/components/responses/404' 
      '411': 
        Reference: './TS29571_CommonData.yaml#/components/responses/411' 
      '413': 
        Reference: './TS29571_CommonData.yaml#/components/responses/413' 
      '415': 
        Reference: './TS29571_CommonData.yaml#/components/responses/415' 
      '429': 
        Reference: './TS29571_CommonData.yaml#/components/responses/429' 
      '500': 
        Reference: './TS29571_CommonData.yaml#/components/responses/500' 
      '503': 
        Reference: './TS29571_CommonData.yaml#/components/responses/503' 
      Default: 
        Reference: './TS29571_CommonData.yaml#/components/responses/default'

Components


securitySchemes: 
  oAuth2ClientCredentials: 
    Type: oauth2 
    Flows: 
      clientCredentials: 
        tokenUrl: '{nrfApiRoot}/oauth2/token' 
        scopes: 
          nchf-spendinglimitcontrol: Access to the Nchf_SpendingLimitControl API