NSPerformanceManagement.yaml 46.1 KB
Newer Older
1001
1002
1003
1004
1005
          required: true
          type: string
      responses:
        204:
          description: > 
1006
1007
            204 No Content          
            
1008
1009
1010
1011
            The subscription resource was deleted successfully.
            The response body shall be empty.
          headers:
            WWW-Authenticate:
1012
              type: "string"
1013
1014
              description: >
                Challenge if the corresponding HTTP request has not provided
1015
1016
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
              maximum: 1
              minimum: 0
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"
        405:
          $ref: "responses/SOL005_resp.yaml#/responses/405"
        406:
          $ref: "responses/SOL005_resp.yaml#/responses/406"
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
          
1034
1035
1036
1037
1038
1039
1040
##################################################################################
# Notification endpoint                                                          #
# Dummy URI is used for testing.                                                 #
# In real, resource URI is provided by the client when creating the subscription.#
##################################################################################
  '/URI_is_provided_by_the_client_when_creating_the_subscription-PerformanceInformationAvailableNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.9
1041
    post:
1042
      summary: Notify about PM related events
1043
      description: >
rameshnaraya's avatar
rameshnaraya committed
1044
1045
1046
        The POST method delivers a notification regarding a performance management event from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters,
1047

1048
      parameters:
rameshnaraya's avatar
rameshnaraya committed
1049
        - name: PerformanceInformationAvailableNotification
1050
          description: >
rameshnaraya's avatar
rameshnaraya committed
1051
            Notification about performance information availability. 
1052
1053
1054
          in: body
          required: true
          schema:
rameshnaraya's avatar
rameshnaraya committed
1055
1056
            properties:
              PerformanceInformationAvailableNotification:
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
                $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/PerformanceInformationAvailableNotification"
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
            204 No Content
            
            The notification was delivered successfully.
          headers:
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0            
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
          
  '/URI_is_provided_by_the_client_when_creating_the_subscription-ThresholdCrossedNotification':
    #ETSI GS NFV-SOL 005 V2.4.1 location: 7.4.9  
    post:
      summary: Notify about PM related events
      description: >
        The POST method delivers a notification regarding a performance management event from the server to the client.
        This method shall follow the provisions specified in the 
        Tables 7.4.9.3.1-1 and 7.4.9.3.1-2 for URI query parameters,

      parameters:           
        - name: ThresholdCrossedNotification
          description: >
            Notification about threshold crossing.
          in: body
          required: true
          schema:
            properties:
              ThresholdCrossedNotification:
                $ref: "definitions/SOL005NSPerfomananceManagement_def.yaml#/definitions/ThresholdCrossedNotification"                
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
        - name: Content-Type
          description: >
            The MIME type of the body of the request.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
      responses:
        204:
          description: >
1148
            204 No Content
1149
            
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
            The notification was delivered successfully. 
          headers:
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0            
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503" 
1170
          
1171
    get:
1172
      summary: Test the notification endpoint
1173
      description: >
rameshnaraya's avatar
rameshnaraya committed
1174
1175
1176
1177
1178
        The GET method allows the server to test the notification endpoint that is provided by the client, e.g. during
        subscription.
        This method shall follow the provisions specified in the 
        Tables 7.4.9.3.2-1 and 7.4.9.3.2-2 for URI query parameters,
        request and response data structures, and response codes.
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
      parameters:
        - name: Accept
          description: >
            Content-Types that are acceptable for the response.
            Reference: IETF RFC 7231
          in: header
          required: true
          type: string
        - name: Authorization
          description: >
            The authorization token for the request.
            Reference: IETF RFC 7235
          in: header
          required: false
          type: string
      responses:
        204:
          description: >
1197
1198
            204 No Content          
            
1199
1200
            The notification endpoint was tested successfully.
            The response body shall be empty. 
1201
1202
1203
1204
1205
1206
1207
1208
1209
          headers:
            WWW-Authenticate:
              type: "string"
              description: >
                Challenge if the corresponding HTTP request has not provided
                authorization, or error details if the corresponding HTTP request
                has provided an invalid authorization token.
              maximum: 1
              minimum: 0            
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
        400:
          $ref: "responses/SOL005_resp.yaml#/responses/400"
        401:
          $ref: "responses/SOL005_resp.yaml#/responses/401"
        403:
          $ref: "responses/SOL005_resp.yaml#/responses/403"                        
        500:
          $ref: "responses/SOL005_resp.yaml#/responses/500"
        503:
          $ref: "responses/SOL005_resp.yaml#/responses/503"
For faster browsing, not all history is shown. View entire blame