MecServiceMgmtApi.json

        "summary": "update service",
        "description": "This method updates the information about a mecService resource",
        "operationId": "AppServicesServiceId_PUT",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "serviceId",
            "in": "path",
            "description": "Represents a MEC service instance.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "New ServiceInfo with updated \"state\" is included as entity body of the request",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceInfo"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceInfo"
                },
                "examples": {
                  "ServiceInfo": {
                    "value": {
                      "serInstanceId": "ServiceInstance123",
                      "serName": "ExampleService",
                      "serCategory": {
                        "href": "catItem1",
                        "id": "id12345",
                        "name": "RNI",
                        "version": "version1"
                      },
                      "version": "ServiceVersion1",
                      "state": "ACTIVE",
                      "transportInfo": {
                        "id": "TransId12345",
                        "name": "REST",
                        "description": "REST API",
                        "type": "REST_HTTP",
                        "protocol": "HTTP",
                        "version": "2.0",
                        "endpoint": {
                          "uris": [
                            "/mecSerMgmtApi/service/EntryPoint"
                          ]
                        },
                        "security": {
                          "oAuth2Info": {
                            "grantTypes": [
                              "OAUTH2_CLIENT_CREDENTIALS"
                            ],
                            "tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
                          }
                        }
                      },
                      "serializer": "JSON"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "412": {
            "description": "Precondition Failed. It is used when a condition has failed during conditional requests,  e.g. when using ETags to avoid write conflicts.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "delete": {
        "tags": [
          "appServices"
        ],
        "summary": "delete service",
        "description": "This method deletes a mecService resource. This method is typically used in the service deregistration procedure. ",
        "operationId": "AppServicesServiceId_DELETE",
        "parameters": [
          {
            "name": "appInstanceId",
            "in": "path",
            "description": "Represents a MEC application instance. Note that the appInstanceId is allocated by the MEC platform manager.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "serviceId",
            "in": "path",
            "description": "Represents a MEC service instance.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "204": {
            "description": "No Content",
            "headers": {
            },
            "content": {
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/services": {
      "get": {
        "tags": [
          "services"
        ],
        "summary": "get services",
        "description": "This method retrieves information about a list of mecService resources. This method is typically used in \"service availability query\" procedure",
        "operationId": "Services_GET",
        "parameters": [
          {
            "name": "ser_instance_id",
            "in": "query",
            "description": "A MEC application instance may use multiple ser_instance_ids as an input parameter to query the availability of a list of MEC service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "ser_name",
            "in": "query",
            "description": "A MEC application instance may use multiple ser_names as an input parameter to query the availability of a list of MEC service instances. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "ser_category_id",
            "in": "query",
            "description": "A MEC application instance may use ser_category_id as an input parameter to query the availability of a list of MEC service instances in a serCategory. Either \"ser_instance_id\" or \"ser_name\" or \"ser_category_id\" or none of them shall be present.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "consumed_local_only",
            "in": "query",
            "description": "Indicate whether the service can only be consumed by the MEC  applications located in the same locality (as defined by  scopeOfLocality) as this service instance.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "is_local",
            "in": "query",
            "description": "Indicate whether the service is located in the same locality (as  defined by scopeOfLocality) as the consuming MEC application.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "scope_of_locality",
            "in": "query",
            "description": "A MEC application instance may use scope_of_locality as an input  parameter to query the availability of a list of MEC service instances  with a certain scope of locality.",
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/ServiceInfo"
                  },
                  "description": "",
                  "examples": [
                    [
                      {
                        "serInstanceId": "ServiceInstance123",
                        "serName": "ExampleService",
                        "serCategory": {
                          "href": "catItem1",
                          "id": "id12345",
                          "name": "RNI",
                          "version": "version1"
                        },
                        "version": "ServiceVersion1",
                        "state": "ACTIVE",
                        "transportInfo": {
                          "id": "TransId12345",
                          "name": "REST",
                          "description": "REST API",
                          "type": "REST_HTTP",
                          "protocol": "HTTP",
                          "version": "2.0",
                          "endpoint": {
                            "addresses": [
                              {
                                "host": "192.0.2.0",
                                "port": 8080
                              }
                            ]
                          },
                          "security": {
                            "oAuth2Info": {
                              "grantTypes": [
                                "OAUTH2_CLIENT_CREDENTIALS"
                              ],
                              "tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
                            }
                          }
                        },
                        "serializer": "JSON"
                      }
                    ]
                  ],
                  "contentMediaType": "application/json"
                },
                "examples": {
                  "ServiceInfoList": {
                    "value": [
                      {
                        "serInstanceId": "ServiceInstance123",
                        "serName": "ExampleService",
                        "serCategory": {
                          "href": "catItem1",
                          "id": "id12345",
                          "name": "RNI",
                          "version": "version1"
                        },
                        "version": "ServiceVersion1",
                        "state": "ACTIVE",
                        "transportInfo": {
                          "id": "TransId12345",
                          "name": "REST",
                          "description": "REST API",
                          "type": "REST_HTTP",
                          "protocol": "HTTP",
                          "version": "2.0",
                          "endpoint": {
                            "addresses": [
                              {
                                "host": "192.0.2.0",
                                "port": 8080
                              }
                            ]
                          },
                          "security": {
                            "oAuth2Info": {
                              "grantTypes": [
                                "OAUTH2_CLIENT_CREDENTIALS"
                              ],
                              "tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
                            }
                          }
                        },
                        "serializer": "JSON"
                      }
                    ]
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "414": {
            "description": "It is used to indicate that the server is refusing to process the request because the request URI is longer than the server is willing or able to process.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/services/{serviceId}": {
      "get": {
        "tags": [
          "services"
        ],
        "summary": "get service",
        "description": "This method retrieves information about a mecService resource. This method is typically used in \"service availability query\" procedure",
        "operationId": "ServicesServiceId_GET",
        "parameters": [
          {
            "name": "serviceId",
            "in": "path",
            "description": "Represents a MEC service instance.",
            "required": true,
            "style": "simple",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceInfo"
                },
                "examples": {
                  "ServiceInfo": {
                    "value": {
                      "serInstanceId": "ServiceInstance123",
                      "serName": "ExampleService",
                      "serCategory": {
                        "href": "catItem1",
                        "id": "id12345",
                        "name": "RNI",
                        "version": "version1"
                      },
                      "version": "ServiceVersion1",
                      "state": "ACTIVE",
                      "transportInfo": {
                        "id": "TransId12345",
                        "name": "REST",
                        "description": "REST API",
                        "type": "REST_HTTP",
                        "protocol": "HTTP",
                        "version": "2.0",
                        "endpoint": {
                          "uris": [
                            "/mecSerMgmtApi/service/EntryPoint"
                          ]
                        },
                        "security": {
                          "oAuth2Info": {
                            "grantTypes": [
                              "OAUTH2_CLIENT_CREDENTIALS"
                            ],
                            "tokenEndpoint": "/mecSerMgmtApi/security/TokenEndPoint"
                          }
                        }
                      },
                      "serializer": "JSON"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/transports": {
      "get": {
        "tags": [
          "transports"
        ],
        "summary": "Get transports",
        "description": "This method retrieves information about a list of available transports. This method is typically used by a service-producing application to discover transports provided by the MEC platform in the \"transport information query\" procedure",
        "operationId": "Transports_GET",
        "parameters": [

        ],
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "headers": {
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/TransportInfo"
                  },
                  "description": "",
                  "contentMediaType": "application/json"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request. It is used to indicate that incorrect parameters were passed to the request.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden. The operation is not allowed given the current status of the resource.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found. It is used when a client provided a URI that cannot be mapped  to a valid resource URI.",
            "headers": {
            },
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              },
              "text/plain": {
                "schema": {
                  "type": "object",
                  "description": "Empty schema",
                  "contentMediaType": "text/plain"
                }
              }
            }
          }
        },
        "deprecated": false
      },
      "parameters": [

      ]
    },
    "/resource_uri_allocated_by_MEC_platform": {
      "get": {
        "tags": [
          "individualMECservice"
        ],
        "summary": "get mecServiceLiveness",
        "description": "This method retrieves information about an \"Individual mecServiceLiveness\" resource",
        "operationId": "get_individual_MEC_service",
        "responses": {
          "200": {
            "description": "It is used to indicate nonspecific success. The response body contains a representation of the resource.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceLivenessInfo"
                }
              }
            }
          },
          "400": {
            "description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      },
      "patch": {
        "tags": [
          "individualMECservice"
        ],
        "summary": "Update mecServiceLiveness",
        "description": "This method updates a resource on top of the existing resource state with partial changes described by the client.",
        "operationId": "patch_individual_MEC_service",
        "requestBody": {
          "description": "It contains an update of the liveness state.",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ServiceLivenessUpdate"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Upon success, a response body is returned containing the updated liveness interval value of the service Instance.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ServiceLivenessInfo"
                }
              }
            }
          },
          "204": {
            "description": "Successful response sent when there is no need to provide a new liveness interval value to the service Instance.",
            "headers": {
            },
            "content": {
            }
          },
          "400": {
            "description": "It is used to indicate that incorrect parameters were passed to the request. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "It is used when a client provided a URI that cannot be mapped to a valid resource URI. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "403": {
            "description": "The operation is not allowed given the current status of the resource. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "The operation is not allowed due to a conflict with the state of the resource. The MEC platform shall respond with this code if the service instance is in \"INACTIVE\" state. More information shall be provided in the \"detail\" attribute of the \"ProblemDetails\" structure.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "412": {
            "description": "It is used when a condition has failed during conditional requests, e.g. when using ETags to avoid write conflicts. In the returned ProblemDetails structure, the \"detail\" attribute should convey more information about the error.",
            "content": {
              "application/problem+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CategoryRef": {
        "title": "CategoryRef",
        "required": [
          "href",
          "id",
          "name",
          "version"
        ],
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "Reference of the catalogue",
            "examples": [
              "/example/catalogue1"
            ]
          },
          "id": {
            "type": "string",
            "description": "Unique identifier of the category",
            "examples": [
              "id12345"
            ]
          },
          "name": {
            "type": "string",
            "description": "Name of the category, example values include RNI, Location & Bandwidth Management",
            "examples": [
              "RNI"
            ]
          },
          "version": {
            "type": "string",
            "description": "Category version",
            "examples": [
              "version1"
            ]
          }
        },
        "description": "This type represents the category reference"
      },
      "EndPointInfo.Address": {
        "title": "EndPointInfo.Address",
        "required": [
          "host",
          "port"
        ],
        "type": "object",
        "properties": {
          "host": {
            "type": "string",
            "description": "Host portion of the address",
            "examples": [
              "192.0.2.0"
            ]
          },
          "port": {
            "type": "integer",
            "description": "Port portion of the address",
            "contentEncoding": "int32",
            "examples": [
              8080
            ]
          }
        },
        "description": "A IP address and port pair"
      },
      "EndPointInfo.Addresses": {
        "title": "EndPointInfo.Addresses",
        "required": [
          "addresses"
        ],
        "type": "object",
        "properties": {
          "addresses": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/EndPointInfo.Address"
            },
            "description": ""
          }
        },
        "description": "Entry point information of the service as one or more pairs of IP address and port"
      },
      "EndPointInfo.Alternative": {
        "title": "EndPointInfo.Alternative",
        "required": [
          "alternative"
        ],
        "type": "object",
        "properties": {
          "alternative": {
            "type": "object"
          }
        },
        "description": "Entry point information of the service in a format defined by an implementation, or in an external specification."
      },
      "EndPointInfo.Uris": {
        "title": "EndPointInfo.Uris",
        "required": [
          "uris"
        ],
        "type": "object",
        "properties": {
          "uris": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": ""
          }
        },
        "description": "Entry point information of the service as string, formatted according to URI syntax"
      },
      "LinkType": {
        "title": "LinkType",
        "type": "object",
        "properties": {
          "href": {
            "type": "string",
            "description": "URI referring to a resource",
            "examples": [
              "/mecSerMgmtApi/example"
            ]
          }
        },
        "description": "This type represents a type of link and may be referenced from data structures"
      },
      "MecServiceMgmtApiSubscriptionLinkList.Links": {
        "title": "MecServiceMgmtApiSubscriptionLinkList.Links",
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "$ref": "#/components/schemas/LinkType"
          },
          "subscriptions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/MecServiceMgmtApiSubscriptionLinkList.Subscription"
            },
            "description": "The MEC application instance's subscriptions"
          }
        },
        "description": "Self-referring URI."
      },
      "MecServiceMgmtApiSubscriptionLinkList.Subscription": {
        "title": "MecServiceMgmtApiSubscriptionLinkList.Subscription",
        "required": [
          "href",
          "rel"
        ],
        "type": "object",