NsdInfos.schema.json

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "nsdOnboardingState",
      "nsdOperationalState",
      "nsdUsageState",
      "_links"
    ],
    "properties": {
      "id": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "nsdId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "nsdName": {
        "type": "string",
        "description": "\"Name of the on boarded NSD. This information is copied from the NSD content and shall be present after the NSD content is on-boarded.\"\n"
      },
      "nsdVersion": {
        "description": "A Version.\n",
        "type": "string"
      },
      "nsdDesigner": {
        "type": "string",
        "description": "\"Designer of the on-boarded NSD. This information is copied from the NSD content and shall be present after the NSD content is on-boarded.\"\n"
      },
      "nsdInvariantId": {
        "description": "An identifier with the intention of being globally unique.\n",
        "type": "string"
      },
      "vnfPkgIds": {
        "description": "Identifies the VNF package for the VNFD referenced by the on-boarded NS descriptor resource.\n",
        "type": "array",
        "items": {
          "description": "An identifier with the intention of being globally unique.\n",
          "type": "string"
        }
      },
      "pnfdInfoIds": {
        "description": "Identifies the PnfdInfo element for the PNFD referenced by the on-boarded NS descriptor resource.\n",
        "type": "array",
        "items": {
          "description": "An identifier with the intention of being globally unique.\n",
          "type": "string"
        }
      },
      "nestedNsdInfoIds": {
        "description": "Identifies the NsdInfo element for the nested NSD referenced by the on-boarded NS descriptor resource.\n",
        "type": "array",
        "items": {
          "description": "An identifier with the intention of being globally unique.\n",
          "type": "string"
        }
      },
      "nsdOnboardingState": {
        "type": "string",
        "description": "\"The enumeration NsdOnboardingStateType shall comply with the provisions defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding state of the NSD. CREATED = The NSD information object is created.  UPLOADING = The associated NSD content is being uploaded.  PROCESSING = The associated NSD content is being processed, e.g. validation.  ONBOARDED = The associated NSD content is on-boarded.\"\n",
        "enum": [
          "CREATED",
          "UPLOADING",
          "PROCESSING",
          "ONBOARDED"
        ]
      },
      "onboardingFailureDetails": {
        "description": "The definition of the general \"ProblemDetails\" data structure from IETF RFC 7807 [19] is reproduced in this structure. Compared to the general framework defined in IETF RFC 7807 [19], the \"status\" and \"detail\" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 [19] foresees extensibility of the \"ProblemDetails\" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807 [19].\n",
        "type": "object",
        "required": [
          "status",
          "detail"
        ],
        "properties": {
          "type": {
            "description": "A URI reference according to IETF RFC 3986 [5] that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be \"about:blank\".\n",
            "type": "string",
            "format": "URI"
          },
          "title": {
            "description": "A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than \"about:blank\", this attribute shall also be provided. A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).\n",
            "type": "string"
          },
          "status": {
            "description": "The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.\n",
            "type": "integer"
          },
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem.\n",
            "type": "string"
          },
          "instance": {
            "description": "A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.\n",
            "type": "string",
            "format": "URI"
          }
        }
      },
      "nsdOperationalState": {
        "type": "string",
        "description": "\"The enumeration NsdOperationalStateType shall comply with the provisions defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational state of the resource. ENABLED = The operational state of the resource is enabled.  DISABLED = The operational state of the resource is disabled.\"\n",
        "enum": [
          "ENABLED",
          "DISABLED"
        ]
      },
      "nsdUsageState": {
        "type": "string",
        "description": "\"The enumeration NsdUsageStateType shall comply with the provisions defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource is not-in-use.\"\n",
        "enum": [
          "IN_USE",
          "NOT_IN_USE"
        ]
      },
      "userDefinedData": {
        "description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions  defined in clause 4 of IETF RFC 7159. \n",
        "type": "object"
      },
      "_links": {
        "type": "object",
        "required": [
          "self",
          "nsd_content"
        ],
        "description": "\"Links to resources related to this resource.\"\n",
        "properties": {
          "self": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of the referenced resource.\n",
                "type": "string",
                "format": "url"
              }
            }
          },
          "nsd_content": {
            "description": "This type represents a link to a resource.\n",
            "type": "object",
            "required": [
              "href"
            ],
            "properties": {
              "href": {
                "description": "URI of the referenced resource.\n",
                "type": "string",
                "format": "url"
              }
            }
          }
        }
      }
    },
    "description": "\"This type represents a response for the query NSD operation.\"\t\n"
  }
}