NSDManagement.yaml 92.7 KB
Newer Older
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

  ###############################################################################
  # Individual Subscription                                                     #
  ###############################################################################
  /subscriptions/{subscriptionId}:
    #ETSI GS NFV-SOL 005 V2.4.1 location: 5.4.9    
    parameters:
      - $ref: '#/components/parameters/SubscriptionId'
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Authorization
      - $ref: ../components/SOL005_params.yaml#/components/parameters/Version
        The GET method retrieves information about a subscription by reading an individual subscription resource.
        See clause 5.4.9.3.2.
        - $ref: ../components/SOL005_params.yaml#/components/parameters/Accept
      responses:
        200:
          $ref: '#/components/responses/IndividualSubscription.Get.200'
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"
        The DELETE method terminates an individual subscription. See clause 5.4.9.3.5.
      responses:
        204:
          $ref: '#/components/responses/IndividualSubscription.Delete.204'
          $ref: "../responses/SOL005_resp.yaml#/components/responses/400"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/401"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/403"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/404"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/405"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/406"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/500"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/503"
          $ref: "../responses/SOL005_resp.yaml#/components/responses/504"

components:
  parameters:
    AcceptTextOrZip:
      name: Accept
      description: >
        The request shall contain the appropriate entries in the "Accept" HTTP header.
      in: header
      required: true
      schema:
        type: string
        enum:
          - text/plain
          - application/zip
    AcceptText:
      name: Accept
      description: >
        The request shall contain the appropriate entries in the "Accept" HTTP header.
      in: header
      required: true
      schema:
        type: string
        enum:
          - text/plain
    ContentTypeZip:
      name: Content-Type
      description: |
        The payload body contains a ZIP file that represents the NSD archive, as specified above.
            The request shall set the "Content-Type" HTTP header to "application/zip".
      in: header
      required: true
      schema:
        type: string
        enum:
          - application/zip

    NsdInfoId:
      name: nsdInfoId
      in: path
      description: |
        Identifier of the individual NS descriptor resource.
      required: true
      style: simple
      explode: false
      schema:
        type: string
    
    PnfdInfoId:
      name: pnfdInfoId
      in: path
      description: |
          Identifier of the individual PNF descriptor resource.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPathInNSD:
      name: artifactPath
      in: path
      description: |
        For an artifact contained as a file in the NSD archive, this variable shall 
        contain a sequence of one or path segments representing the path of the 
        artifact within the NSD archive, relative to the root of the package.

        EXAMPLE: foo/bar/m%40ster.sh
        
        For an external artifact represented as a URI in the NSD archive manifest, 
        this variable shall contain the URI as provided in the NS archive.

        This identifier can be retrieved from the "artifactPath" attribute of the 
        applicable "artifacts" entry in the body of the response to a GET request 
        querying the "Individual NSD" resource.
        
        Since multiple path segments are allowed to be contained in this variable, 
        the "/" character that separates these segments is not percent-encoded. 
        Each individual segment is percent-encoded if necessary as defined in 
        clause 4.1 of ETSI GS NFV-SOL 013.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    ArtifactPathInPNFD:
      name: artifactPath
      in: path
      description: |
        For an artifact contained as a file in the PNFD archive, this variable shall contain 
        a sequence of one or path segments representing the path of the artifact within the 
        PNFD archive, relative to the root of the package.

        EXAMPLE: foo/bar/m%40ster.sh

        For an external artifact represented as a URI in the PNFD archive manifest, this variable 
        shall contain the URI as provided in the NS archive.

        This identifier can be retrieved from the "artifactPath" attribute of the applicable 
        "artifacts" entry in the body of the response to a GET request querying the "Individual PNFD" 
        resource. 
        
        Since multiple path segments are allowed to be contained in this variable, the "/" character 
        that separates these segments is not percent-encoded. Each individual segment is percent-encoded 
        if necessary as defined in clause 4.1 of ETSI GS NFV-SOL 013.
      required: true
      style: simple
      explode: false
      schema:
        type: string

    SubscriptionId:
      name: subscriptionId
      in: path
      description: |
          Identifier of this subscription. 
          This identifier can be retrieved from the resource referenced by the "Location" HTTP header in 
          the response to a POST request creating a new subscription resource. It can also be retrieved
          from the "id" attribute in the payload body of that response.
      required: true
      style: simple
      explode: false
      schema:
        type: string
  
  requestBodies:
    CreateNsdInfoRequest:
      description: |
        Parameters of creating an NS descriptor resource, as defined in clause 5.5.2.3.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreateNsdInfoRequest"
      required: true

    NsdInfoModifications:
      description: |
        Parameters for the modification of an individual NS descriptor resource, as defined in clause 5.5.2.1.
        The Content-Type header shall be set to "application/merge-patch+json" according to IETF RFC 7396.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"
      required: true

    CreatePnfdInfoRequest:
      description: |
        Parameters of creating a PNF descriptor resource.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/CreatePnfdInfoRequest"
      required: true

    PnfdInfoModifications:
      description: |
        Parameters for the modification of an individual
        PNF descriptor resource, as defined in clause 5.5.2.4.
        The Content-Type header shall be set to "application/merge-patch+json"
        according to IETF RFC 7396.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"
      required: true

    NsdmSubscriptionRequest:
      description: |
        Details of the subscription to be created, as defined in clause 5.5.2.7.
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdmSubscriptionRequest"
      required: true

  responses:
    NSDescriptors.Post.201:
      description: |
        201 CREATED

        Shall be returned when a new "Individual NS descriptor" resource
        and the associated NS descriptor identifier has been created successfully.
        The response body shall contain a representation of the created NS descriptor
        resource, as defined in clause 5.5.2.2.
        The HTTP response shall include a "Location" HTTP header that contains the
        resource URI of the created NS descriptor resource.
      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
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"

    NSDescriptors.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or
        more NS descriptors has been queried successfully.
        The response body shall contain in an array the
        representations of zero or more NS descriptors, as
        defined in clause 5.5.2.2.
        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/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"

    IndividualNSDescriptor.Get.200:
      description: |
        200 OK

        Shall be returned when information about the individual
        NS descriptor has been read successfully.
        The response body shall contain a representation of
        the individual NS descriptor, as defined in
        clause 5.5.2.2.
      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
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfo"

    IndividualNSDescriptor.Patch.200:
      description: |
        200 OK

        Shall be returned when the operation has been accepted and completed successfully.
        The response body shall contain attribute modifications for an 'Individual NS descriptor'
1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000
        resource (see clause 5.5.2.6).
      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
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdInfoModifications"

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

        Shall be returned when the operation has completed 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

    NsdArchiveContent.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the NSD has been read successfully.
        The payload body shall contain a copy of the ZIP file that contains the NSD file structure.
        The "Content-Type" HTTP header shall be set to "application/zip".
      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

    NsdArchiveContent.Put.202:
      description: |
        202 ACCEPTED

        Shall be returned when the NSD archive has been accepted for uploading,
        but the processing has not been completed. It is expected to take some
        time for processing (asynchronous mode).
        The response body shall be empty.
        The API consumer can track the uploading progress by receiving the
        "NsdOnBoardingNotification" and "NsdOnBoardingFailureNotification"
        from the NFVO or by reading the status of the individual NS descriptor
        resource using the GET method.
      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

    NsdArchiveContent.Put.204:
      description: |
        204 NO CONTENT

        The NSD content successfully uploaded and
        validated (synchronous mode).
        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

    NSD.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the NSD has been read successfully.
        The payload body shall contain a copy of the file representing the NSD or
        a ZIP file that contains the file or multiple files representing the NSD,
        as specified above.
        The "Content-Type" HTTP header shall be set according to the format of
        the returned file. It shall be set to "text/plain" for a YAML file.
      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

    NsdArchiveManifest.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the manifest file has been read successfully.

        If the "include_signatures" URI query parameter was absent in the request, or if the
        manifest file has all security-related information embedded (i.e. there is no separate
        certificate file), the payload body shall contain a copy of the manifest file of the
        NSD archive, and the "Content-Type" HTTP header shall be set to "text/plain".
        If the "include_signatures" URI query parameter was present in the related request and
        the manifest file does not have all the security-related information embedded (i.e. there
        is a separate certificate file), the "Content-Type" HTTP header shall be set to "application/zip"
        and the payload body shall contain a ZIP archive which includes:
        -	a copy of the manifest file of the NSD archive;
        -	a copy of the related individual certificate file.
      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

    IndividualNsdArchiveArtifact.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the artifact file has been read successfully.

        If the "include_signatures" request URI parameter was not provided in the related request, 
        the payload body shall contain a copy of the artifact file from the NSD archive, as defined 
        by ETSI GS NFV-SOL 007, and the "Content-Type" HTTP header shall be set according to the 
        content type of the artifact file. If the artifact is encrypted, the header shall be set to
        the value "application/cms" (IETF RFC 7193). 
        
        If the content type cannot be determined, the header shall be set to the value 
        "application/octet-stream". If the "include_signatures" request URI parameter was provided 
        in the related request, the "Content-Type" HTTP header shall be set to "application/zip"
        and the payload body shall contain a ZIP archive which includes:
        - a copy of the artifact file from the VNF package, as defined by ETSI GS NFVSOL 007
        - the related security information (individual signature file and optional related individual 
        certificate file).
      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

    IndividualNsdArchiveArtifact.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests and the "include_signatures" request URI parameter was
        not present in the related request, this response shall be returned when a single consecutive 
        byte range from the content of the artifact file has been read successfully according to the 
        request.

        The response body shall contain the requested part of the artifact file from the NSD archive, 
        as defined by ETSI GS NFV-SOL 007. 
        
        The "Content-Type" HTTP header shall be set according to the content type of the artifact file. 
        If the content type cannot be determined, the header shall be set to the value 
        "application/octet-stream".

        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
      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

    PNFDescriptors.Post.201:
      description: |
        201 CREATED

        Shall be returned when a new "Individual PNF descriptor"
        resource and the associated PNF descriptor identifier
        has been created successfully.
        The response body shall contain a representation of the
        created PNF descriptor resource, as defined in clause 5.5.2.5.
        The HTTP response shall include a "Location" HTTP header that
        contains the resource URI of the created PNF descriptor resource.
      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
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"

    PNFDescriptors.Get.200:
      description: |
        200 OK

        Shall be returned when information about zero or more PNF descriptors has
        been queried successfully.
        The response body shall contain in an array the representations of zero or
        more PNF descriptors, as defined in clause 5.5.2.5.
        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:
            description: |
              Information about zero or more PNF descriptors.
              The response body shall contain a representation in an array the representations
              of zero or more PNF descriptors, as defined in clause  5.5.2.2.
              If the NFVO supports alternative 2 (paging) according to clause 4.7.2.1 for this resource,
              inclusion of the Link HTTP header in this response shall follow the provisions in clause 4.7.2.3.
            type: array
            items:
              $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"

    IndividualPnfDescriptor.Get.200:
      description: |
        200 OK

        Shall be returned when information about the individual PNFD
        descriptor has been read successfully.
        The response body shall contain a representation of the
        individual PNF descriptor, as defined in clause 5.5.2.5.
      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
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfo"

    IndividualPnfDescriptor.Patch.200:
      description: |
        200 OK

        Shall be returned when the operation has been accepted
        and completed successfully.
        The response body shall contain attribute modifications
        for an 'Individual PNF Descriptor' resource (see clause 5.5.2.4).
      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
      content:
        application/json:
          schema:
            $ref: "definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/PnfdInfoModifications"

    IndividualPnfDescriptor.Delete.200:
      description: |
        204 NO CONTENT

        Shall be returned when the operation
        has completed 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

    PnfdArchiveContent.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the PNFD archive has
        been read successfully.
        The payload body shall contain a copy of the PNFD archive
        The "Content-Type" HTTP header shall be set to "application/zip".
      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

    PnfdArchiveContent.Get.206:
      description: |
        206 PARTIAL CONTENT

        If the NFVO supports range requests, this response shall be returned
        when a single consecutive byte range from the content of the PNFD archive
        has been read successfully according to the request.
        The response body shall contain the requested part of the PNFD archive.
        The "Content-Range" HTTP header shall be provided according to IETF RFC 7233.
        The "Content-Type" HTTP header shall be set as defined above for the "200 OK" response.
      headers:
        Content-Type:
          description: |
            The MIME type of the body of the request. Reference: IETF RFC 7231
          style: simple
          explode: false
          schema:
            type: string
        Content-Range:
          description: The Content-Range response HTTP header indicates where in a full body message a partial message belongs.
          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

    PnfdArchiveContent.Put.200:
      description: |
        202 ACCEPTED

        Shall be returned when the PNFD archive has been accepted for uploading,
        but the processing has not been completed. It is expected to take some
        time for processing (asynchronous mode).
        The response body shall be empty.
        The API consumer can track the uploading progress by receiving the
        "PnfdOnBoardingNotification" and "PnfdOnBoardingFailureNotification"
        from the NFVO or by reading the status of the individual PNF descriptor
        resource using the GET method.
      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

    PnfdArchiveContent.Put.204:
      description: |
        204 NO CONTENT

        Shall be returned when the PNFD archive content has been
        uploaded and validated 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

    PNFD.Get.200:
      description: |
        200 OK

        Shall be returned when the content of the PNFD has been read successfully.
        The payload body shall contain a copy of the file representing the PNFD
        or a ZIP file that contains the file or multiple files representing the
        PNFD, as specified above.
        The "Content-Type" HTTP header shall be set according to the format of
        the returned file. It shall be set to "text/plain" for a YAML file.
      headers:
        Content-Type: