Loading Readme.md +1 −1 Original line number Diff line number Diff line # NFV SOL012 - OpenAPIs for the Policy Management Interface This repository contains OpenAPIs for ETSI GS NFV-SOL 012, RESTful protocols This repository contains OpenAPIs for ETSI GS NFV-SOL 012 v4.4.1, RESTful protocols specification for the Policy Management Interface. More information at [NFV Solutions wiki](https://nfvwiki.etsi.org/index.php?title=NFV_Solutions). Loading src/SOL012/APIVersion/APIVersion.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -23,8 +23,8 @@ info: name: NFV-SOL WG externalDocs: description: ETSI GS NFV-SOL 012 v3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/03.07.01_60/gs_NFV-SOL012v030701p.pdf description: ETSI GS NFV-SOL 012 v4.4.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/04.04.01_60/gs_NFV-SOL012v040401p.pdf paths: /nfvpolicy/api_versions: Loading src/SOL012/PolicyManagement/PolicyManagement.yaml +16 −3 Original line number Diff line number Diff line Loading @@ -15,8 +15,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 012 v3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/03.07.01_60/gs_NFV-SOL012v030701p.pdf description: ETSI GS NFV-SOL 012 v4.4.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/04.04.01_60/gs_NFV-SOL012v040401p.pdf security: - OauthSecurity: Loading Loading @@ -153,7 +153,9 @@ paths: Modification of a policy includes three functionalities: activating/deactivating the policy, changing the associations of the policy, and changing the selected version of the policy. The three functionalities may be combined flexibly in one request unless there's conflict with the state of the policy. the state of the policy. With respect to changing the associations, refer also to the provisions specified in clause 5.5.6.3.3 regarding the initial setting of the "associations" attribute values in the "Individual policy" representation, which can be modified using the present method. parameters: - $ref: "../components/SOL012_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL012_params.yaml#/components/parameters/ContentType" Loading Loading @@ -304,6 +306,17 @@ paths: put: description: > The PUT method transfers the content of a particular version of an individual policy. As the result of successfully executing this method, the API producer shall update the "associations" attribute in the representation of the "Individual policy" resource as follows: - If no associations were provided in the initial creation of the "Individual policy" resource (see clause 5.5.3.3.1) and the policy content includes relevant associations information, the API producer shall set the values of "associations" attribute according to the information in the policy content. - If associations were provided in the initial creation of the "Individual policy" resource (see clause 5.5.3.3.1) or current values are already set on the "associations" attribute in the representation of the "Individual policy" resource, and the policy content includes relevant associations information, the API producer shall not apply the values present in the policy content (i.e., values provided via the API take precedence). This method shall follow the provisions specified in the tables 5.5.6.3.3-1 and 5.5.6.3.3-2 for URI query parameters, request and response data structures, and response codes. parameters: Loading src/SOL012/PolicyManagement/definitions/PolicyManagement_def.yaml +30 −12 Original line number Diff line number Diff line Loading @@ -4,6 +4,12 @@ definitions: description: > This type represents request parameters for creating a policy. It shall comply with the provisions defined in table 5.6.2.2-1. NOTE 1: For example, the PF can be a VNFM or VIM when the API producer is an NFVO. NOTE 2: The associations refer to identifiers of entities that the PF manages. E.g. if the PF is a VNFM, the policy can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances. NOTE 3: How the PF determines the scope of applicability of the policy when this attribute is absent is outside the scope of the present document. type: object properties: designer: Loading @@ -24,12 +30,11 @@ definitions: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Identifier" associations: description: > Initial value of the “associations” attribute in the “Policy” data structure which represents the policy. Shall be absent when the association feature is not applicable for the PF. The associations refer to identifiers of entities that the PF manages. E.g., if the PF is a VNFM, the policy can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances. How the PF determines the scope of applicability of the policy when this attribute is absent is outside the scope of the present document. Initial value of the "associations" attribute in the "Policy" data structure which represents the policy. Shall be absent when the association feature is not applicable for the PF, i.e., the target information in the policy content defined by the "targetType" attribute of the "Policy" information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048] is equal to "COMMON". See note 2 and note 3. type: array items: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Identifier" Loading Loading @@ -65,12 +70,16 @@ definitions: versions: description: > Versions of the policy. Shall be present if at least one version of the policy has been transferred. Its value shall be the same as the version present in the actual policy content as defined by the "policyVersion" attribute in the "Policy" information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048]. type: array items: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Version" selectedVersion: description: > Selected version of the policy. Shall be present if one or more versions of the policy have been transferred. The "versions" attribute provides available values of versions of transferred policies. $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Version" activationStatus: description: > Loading @@ -83,12 +92,15 @@ definitions: associations: description: > Identifiers of the entities that the PF manages and to which the policy associates to. Shall be absent when the association feature is not applicable for the PF. The associations refer to identifiers of entities that the PF manages. E.g., if the PF is a VNFM, the policy can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances. How the PF determines the scope of applicability of the policy when this attribute is absent is outside the scope of the present document. Shall be absent when the association feature is not applicable for the PF, i.e., the target information in the policy content defined by the "targetType" attribute of the "Policy" information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048] is equal to "COMMON". An initial set of associations applicable to a policy to be set by the API producer may either be provided by the "associations" attribute in the "CreatePolicyRequest" or by the actual policy content via the "targetObjectId" attribute of the "Policy” information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048]. Values of the "associations" attribute can be further modified with the PATCH method. See note 2 and note 3. type: array items: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Identifier" Loading Loading @@ -189,6 +201,12 @@ definitions: order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NOTE 1: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. NOTE 2: For "PolicyConflictNotification", the notification is sent if any of the policies specified in the subscription is impacted by the conflict, as defined in clause 5.6.2.8. type: object properties: notificationTypes: Loading src/SOL012/PolicyManagementNotification/PolicyManagementNotification.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -15,8 +15,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 012 v3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/03.07.01_60/gs_NFV-SOL012v030701p.pdf description: ETSI GS NFV-SOL 012 v4.4.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/04.04.01_60/gs_NFV-SOL012v040401p.pdf security: - OauthSecurity: Loading Loading
Readme.md +1 −1 Original line number Diff line number Diff line # NFV SOL012 - OpenAPIs for the Policy Management Interface This repository contains OpenAPIs for ETSI GS NFV-SOL 012, RESTful protocols This repository contains OpenAPIs for ETSI GS NFV-SOL 012 v4.4.1, RESTful protocols specification for the Policy Management Interface. More information at [NFV Solutions wiki](https://nfvwiki.etsi.org/index.php?title=NFV_Solutions). Loading
src/SOL012/APIVersion/APIVersion.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -23,8 +23,8 @@ info: name: NFV-SOL WG externalDocs: description: ETSI GS NFV-SOL 012 v3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/03.07.01_60/gs_NFV-SOL012v030701p.pdf description: ETSI GS NFV-SOL 012 v4.4.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/04.04.01_60/gs_NFV-SOL012v040401p.pdf paths: /nfvpolicy/api_versions: Loading
src/SOL012/PolicyManagement/PolicyManagement.yaml +16 −3 Original line number Diff line number Diff line Loading @@ -15,8 +15,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 012 v3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/03.07.01_60/gs_NFV-SOL012v030701p.pdf description: ETSI GS NFV-SOL 012 v4.4.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/04.04.01_60/gs_NFV-SOL012v040401p.pdf security: - OauthSecurity: Loading Loading @@ -153,7 +153,9 @@ paths: Modification of a policy includes three functionalities: activating/deactivating the policy, changing the associations of the policy, and changing the selected version of the policy. The three functionalities may be combined flexibly in one request unless there's conflict with the state of the policy. the state of the policy. With respect to changing the associations, refer also to the provisions specified in clause 5.5.6.3.3 regarding the initial setting of the "associations" attribute values in the "Individual policy" representation, which can be modified using the present method. parameters: - $ref: "../components/SOL012_params.yaml#/components/parameters/Accept" - $ref: "../components/SOL012_params.yaml#/components/parameters/ContentType" Loading Loading @@ -304,6 +306,17 @@ paths: put: description: > The PUT method transfers the content of a particular version of an individual policy. As the result of successfully executing this method, the API producer shall update the "associations" attribute in the representation of the "Individual policy" resource as follows: - If no associations were provided in the initial creation of the "Individual policy" resource (see clause 5.5.3.3.1) and the policy content includes relevant associations information, the API producer shall set the values of "associations" attribute according to the information in the policy content. - If associations were provided in the initial creation of the "Individual policy" resource (see clause 5.5.3.3.1) or current values are already set on the "associations" attribute in the representation of the "Individual policy" resource, and the policy content includes relevant associations information, the API producer shall not apply the values present in the policy content (i.e., values provided via the API take precedence). This method shall follow the provisions specified in the tables 5.5.6.3.3-1 and 5.5.6.3.3-2 for URI query parameters, request and response data structures, and response codes. parameters: Loading
src/SOL012/PolicyManagement/definitions/PolicyManagement_def.yaml +30 −12 Original line number Diff line number Diff line Loading @@ -4,6 +4,12 @@ definitions: description: > This type represents request parameters for creating a policy. It shall comply with the provisions defined in table 5.6.2.2-1. NOTE 1: For example, the PF can be a VNFM or VIM when the API producer is an NFVO. NOTE 2: The associations refer to identifiers of entities that the PF manages. E.g. if the PF is a VNFM, the policy can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances. NOTE 3: How the PF determines the scope of applicability of the policy when this attribute is absent is outside the scope of the present document. type: object properties: designer: Loading @@ -24,12 +30,11 @@ definitions: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Identifier" associations: description: > Initial value of the “associations” attribute in the “Policy” data structure which represents the policy. Shall be absent when the association feature is not applicable for the PF. The associations refer to identifiers of entities that the PF manages. E.g., if the PF is a VNFM, the policy can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances. How the PF determines the scope of applicability of the policy when this attribute is absent is outside the scope of the present document. Initial value of the "associations" attribute in the "Policy" data structure which represents the policy. Shall be absent when the association feature is not applicable for the PF, i.e., the target information in the policy content defined by the "targetType" attribute of the "Policy" information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048] is equal to "COMMON". See note 2 and note 3. type: array items: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Identifier" Loading Loading @@ -65,12 +70,16 @@ definitions: versions: description: > Versions of the policy. Shall be present if at least one version of the policy has been transferred. Its value shall be the same as the version present in the actual policy content as defined by the "policyVersion" attribute in the "Policy" information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048]. type: array items: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Version" selectedVersion: description: > Selected version of the policy. Shall be present if one or more versions of the policy have been transferred. The "versions" attribute provides available values of versions of transferred policies. $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Version" activationStatus: description: > Loading @@ -83,12 +92,15 @@ definitions: associations: description: > Identifiers of the entities that the PF manages and to which the policy associates to. Shall be absent when the association feature is not applicable for the PF. The associations refer to identifiers of entities that the PF manages. E.g., if the PF is a VNFM, the policy can associate to VNF instances; if the PF is NFVO, the policy can associate to an NS instances. How the PF determines the scope of applicability of the policy when this attribute is absent is outside the scope of the present document. Shall be absent when the association feature is not applicable for the PF, i.e., the target information in the policy content defined by the "targetType" attribute of the "Policy" information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048] is equal to "COMMON". An initial set of associations applicable to a policy to be set by the API producer may either be provided by the "associations" attribute in the "CreatePolicyRequest" or by the actual policy content via the "targetObjectId" attribute of the "Policy” information element specified in clause 5.2 of ETSI GS NFV-IFA 048 [ref-ifa048]. Values of the "associations" attribute can be further modified with the PATCH method. See note 2 and note 3. type: array items: $ref: "../../definitions/SOL012_def.yaml#/definitions/schemas/Identifier" Loading Loading @@ -189,6 +201,12 @@ definitions: order for the filter to match (logical "and" between different filter attributes). If an attribute is an array, the attribute shall match if at least one of the values in the array matches (logical "or" between the values of one filter attribute). NOTE 1: The permitted values of the "notificationTypes" attribute are spelled exactly as the names of the notification types to facilitate automated code generation systems. NOTE 2: For "PolicyConflictNotification", the notification is sent if any of the policies specified in the subscription is impacted by the conflict, as defined in clause 5.6.2.8. type: object properties: notificationTypes: Loading
src/SOL012/PolicyManagementNotification/PolicyManagementNotification.yaml +2 −2 Original line number Diff line number Diff line Loading @@ -15,8 +15,8 @@ info: name: ETSI Forge copyright notice url: https://forge.etsi.org/etsi-forge-copyright-notice.txt externalDocs: description: ETSI GS NFV-SOL 012 v3.7.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/03.07.01_60/gs_NFV-SOL012v030701p.pdf description: ETSI GS NFV-SOL 012 v4.4.1 url: https://www.etsi.org/deliver/etsi_gs/NFV-SOL/001_099/012/04.04.01_60/gs_NFV-SOL012v040401p.pdf security: - OauthSecurity: Loading
