Skip to content
GitLab
Find file Normal viewHistoryPermalink
NSPerformanceManagement.yaml 49.8 KB
Newer Older
Samir Medjiah's avatar
SOL005: NS PM interface migrated to OpenAPI 3.0.2  
Samir Medjiah committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 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 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJob"

    IndividualPMJob.Patch.200:
      description: |
        200 OK

        Shall be returned when the request has been processed successfully.
        The response body shall contain a data structure of type "PmJobModifications".
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PmJobModifications"

    IndividualPMJob.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the PM job has been deleted successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string

    IndividualPerformanceReport.Get.200:
      description: |
        200 OK

        Shall be returned when information of an individual performance 
        report has been read successfully.
        The response body shall contain a representation of the "Individual performance
        report" resource, as defined in clause 7.5.2.10.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.This header
            field shall be present if the response has a non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/PerformanceReport"

    Thresholds.Post.201:
      description: |
        201 CREATED

        Shall be returned when a threshold has been created successfully.
        The response body shall contain a representation of
        the created "Individual threshold" resource, as defined in clause 7.5.2.9.
        The HTTP response shall include a "Location" HTTP
        header that contains the resource URI of the created
        threshold resource.            
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.This header
            field shall be present if the response has a non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"

    Thresholds.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more thresholds was queried 
        successfully.
        If the "filter" URI parameter was supplied in the request, the data in the 
        response body shall have been transformed according to the rules specified 
        in clause 5.2.2 of ETSI GS NFV-SOL 013.
        The response body shall contain representations of zero or more thresholds,
        as defined in clause 7.5.2.9.
        If the NFVO supports alternative 2 (paging) according to clause 5.4.2.1 of 
        ETSI GS NFV SOL 013 for this resource, inclusion of the Link HTTP header 
        in this response shall follow the provisions in clause 5.4.2.3 of 
        ETSI GS NFV SOL 013.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
        Link:
          description: |
            Reference to other resources. Used for paging in the present document, see clause 4.7.2.1.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"

    IndividualThreshold.Get.200:
      description: |
        200 OK

        Shall be returned when information about an individual threshold 
        has been queried successfully.
        The response body shall contain a representation of
        the threshold, as defined in clause 7.5.2.9.            
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the response.This header
            field shall be present if the response has a non-empty message body.
          style: simple
          explode: false
          schema:
            type: string
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/Threshold"

    IndividualThreshold.Patch.200:
      description: |
        200 OK

        Shall be returned when the request has been processed successfully.
        The response body shall contain a data structure of type "ThresholdModifications".
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSPerformanceManagement_def.yaml#/definitions/ThresholdModifications"

    IndividualThreshold.Delete.204:
      description: |
        204 NO CONTENT

        Shall be returned when the threshold has been deleted successfully.
        The response body shall be empty.
      headers:
        WWW-Authenticate:
          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.
          style: simple
          explode: false
          schema:
            type: string
        Version:
          description: |
            Version of the API used in the response.
          style: simple
          explode: false
          schema:
            type: string
Show full blame