Loading 12-osm-nbi.md +99 −7 Original line number Diff line number Diff line Loading @@ -91,6 +91,8 @@ URL: /osm GET POST /pnf_descriptors 5 5 /<pnfdInfoId> 5 5 5 /pnfd_content 5 5 /subscriptions 5 5 /<subscriptionId> 5 X /vnfpkgm/v1 /vnf_packages_content O O Loading @@ -101,6 +103,8 @@ URL: /osm GET POST /upload_from_uri X /vnfd O5 /artifacts[/<artifactPath>] O5 /subscriptions X X /<subscriptionId> X X /nslcm/v1 /ns_instances_content O O Loading @@ -117,9 +121,11 @@ URL: /osm GET POST TO BE COMPLETED 5 5 /vnf_instances (also vnfrs for compatibility) O /<vnfInstanceId> O /subscriptions 5 5 /<subscriptionId> 5 X /pdu/v1 /pdu_descriptor O O /pdu_descriptors O O /<id> O O O O /admin/v1 Loading @@ -135,6 +141,10 @@ URL: /osm GET POST /<id> O O O /sdns O O /<id> O O O /k8sclusters O O /<id> O O O /k8srepos O O /<id> O O /nst/v1 O O /netslice_templates_content O O Loading @@ -144,6 +154,8 @@ URL: /osm GET POST /nst_content O O /nst O /artifacts[/<artifactPath>] O /subscriptions X X /<subscriptionId> X X /nsilcm/v1 /netslice_instances_content O O Loading @@ -155,6 +167,62 @@ URL: /osm GET POST action O /nsi_lcm_op_occs O O /<nsiLcmOpOccId> O O O /subscriptions X X /<subscriptionId> X X query string: Follows SOL005 section 4.3.2 It contains extra METHOD to override http method, FORCE to force. simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]* filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]* op := "eq" | "neq" (or "ne") | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" attrName := string For filtering inside array, it must select the element of the array, or add ANYINDEX to apply the filtering over any item of the array, that is, pass if any item of the array pass the filter. It allows both ne and neq for not equal TODO: 4.3.3 Attribute selectors all_fields, fields=x,y,.., exclude_default, exclude_fields=x,y,... (none)... same as “exclude_default” all_fields... all attributes. fields=<list>... all attributes except all complex attributes with minimum cardinality of zero that are not conditionally mandatory, and that are not provided in <list>. exclude_fields=<list>... all attributes except those complex attributes with a minimum cardinality of zero that are not conditionally mandatory, and that are provided in <list>. exclude_default... all attributes except those complex attributes with a minimum cardinality of zero that are not conditionally mandatory, and that are part of the "default exclude set" defined in the present specification for the particular resource exclude_default and include=<list>... all attributes except those complex attributes with a minimum cardinality of zero that are not conditionally mandatory and that are part of the "default exclude set" defined in the present specification for the particular resource, but that are not part of <list> Additionally it admits some administrator values: FORCE: To force operations skipping dependency checkings ADMIN: To act as an administrator or a different project PUBLIC: To get public descriptors or set a descriptor as public SET_PROJECT: To make a descriptor available for other project Header field name Reference Example Descriptions Accept IETF RFC 7231 [19] application/json Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the request. This header field shall be present if the request has a non-empty message body. Authorization IETF RFC 7235 [22] Bearer mF_9.B5f-4.1JqM The authorization token for the request. Details are specified in clause 4.5.3. Range IETF RFC 7233 [21] 1000-2000 Requested range of bytes from a file Header field name Reference Example Descriptions Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the response. This header field shall be present if the response has a non-empty message body. Location IETF RFC 7231 [19] http://www.example.com/vnflcm/v1/vnf_instances/123 Used in redirection, or when a new resource has been created. This header field shall be present if the response status code is 201 or 3xx. In the present document this header field is also used if the response status code is 202 and a new resource was created. WWW-Authenticate IETF RFC 7235 [22] Bearer realm="example" Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. Accept-Ranges IETF RFC 7233 [21] bytes Used by the Server to signal whether or not it supports ranges for certain resources. Content-Range IETF RFC 7233 [21] bytes 21010-47021/ 47022 Signals the byte range that is contained in the response, and the total length of the file. Retry-After IETF RFC 7231 [19] Fri, 31 Dec 1999 23:59:59 GMT``` ``` ## Administrative Content Details Loading Loading @@ -233,6 +301,18 @@ URL: /osm GET POST - POST: Add a new sdn. - Example of request content: TODO `/admin/v1/k8sclusters`. (rbac: `k8sclusters`). K8S Clusters to deploy juju bundles or helm packages - GET: Gets k8s clusters - POST: Add a new k8s cluster. - Example of request content: TODO `/admin/v1/k8srepos`. (rbac: `k8srepos`). K8S repository that contains the juju bundles or helm packages - GET: Gets k8s repositories - POST: Add a new k8s repository. - Example of request content: TODO `/admin/v1/sdns/`. (rbac: `sdn_controllers:id`) - GET: Get sdn details Loading @@ -240,6 +320,18 @@ URL: /osm GET POST - Example of sdn edition: TODO - DELETE: Removes sdn. `/admin/v1/k8sclusters/`. (rbac: `k8sclusters:id`) - GET: Get k8sclusters details - PUT/PATCH: Edit k8sclusters. - DELETE: Removes k8sclusters. `/admin/v1/k8srepos/`. (rbac: `k8srepos:id`) - GET: Get k8srepos details - PUT/PATCH: Edit k8srepos. - DELETE: Removes k8srepos. ## PDU Details Physical Data Unit. This is catalogue of physical elements present at some vim_account/s. Deployment of a PNFD/HNFD implies using one of this pdu from the catalogue. Matching from PNFD/HNFD to PDU is done by 'pdu.type' Loading Loading @@ -284,7 +376,7 @@ TBC ## NSLCM Details Network Services Life Ciclo Management Network Services Lifecycle Management `/nslcm/v1/ns_instances_content`. Loading Loading @@ -424,7 +516,7 @@ NetSlice Template descriptor ## NSILCM Details NetSlice Instance Life Cicle Management NetSlice Instance Lifecycle Management `/nsilcm/v1/netslice_instances_content` Loading Loading
12-osm-nbi.md +99 −7 Original line number Diff line number Diff line Loading @@ -91,6 +91,8 @@ URL: /osm GET POST /pnf_descriptors 5 5 /<pnfdInfoId> 5 5 5 /pnfd_content 5 5 /subscriptions 5 5 /<subscriptionId> 5 X /vnfpkgm/v1 /vnf_packages_content O O Loading @@ -101,6 +103,8 @@ URL: /osm GET POST /upload_from_uri X /vnfd O5 /artifacts[/<artifactPath>] O5 /subscriptions X X /<subscriptionId> X X /nslcm/v1 /ns_instances_content O O Loading @@ -117,9 +121,11 @@ URL: /osm GET POST TO BE COMPLETED 5 5 /vnf_instances (also vnfrs for compatibility) O /<vnfInstanceId> O /subscriptions 5 5 /<subscriptionId> 5 X /pdu/v1 /pdu_descriptor O O /pdu_descriptors O O /<id> O O O O /admin/v1 Loading @@ -135,6 +141,10 @@ URL: /osm GET POST /<id> O O O /sdns O O /<id> O O O /k8sclusters O O /<id> O O O /k8srepos O O /<id> O O /nst/v1 O O /netslice_templates_content O O Loading @@ -144,6 +154,8 @@ URL: /osm GET POST /nst_content O O /nst O /artifacts[/<artifactPath>] O /subscriptions X X /<subscriptionId> X X /nsilcm/v1 /netslice_instances_content O O Loading @@ -155,6 +167,62 @@ URL: /osm GET POST action O /nsi_lcm_op_occs O O /<nsiLcmOpOccId> O O O /subscriptions X X /<subscriptionId> X X query string: Follows SOL005 section 4.3.2 It contains extra METHOD to override http method, FORCE to force. simpleFilterExpr := <attrName>["."<attrName>]*["."<op>]"="<value>[","<value>]* filterExpr := <simpleFilterExpr>["&"<simpleFilterExpr>]* op := "eq" | "neq" (or "ne") | "gt" | "lt" | "gte" | "lte" | "cont" | "ncont" attrName := string For filtering inside array, it must select the element of the array, or add ANYINDEX to apply the filtering over any item of the array, that is, pass if any item of the array pass the filter. It allows both ne and neq for not equal TODO: 4.3.3 Attribute selectors all_fields, fields=x,y,.., exclude_default, exclude_fields=x,y,... (none)... same as “exclude_default” all_fields... all attributes. fields=<list>... all attributes except all complex attributes with minimum cardinality of zero that are not conditionally mandatory, and that are not provided in <list>. exclude_fields=<list>... all attributes except those complex attributes with a minimum cardinality of zero that are not conditionally mandatory, and that are provided in <list>. exclude_default... all attributes except those complex attributes with a minimum cardinality of zero that are not conditionally mandatory, and that are part of the "default exclude set" defined in the present specification for the particular resource exclude_default and include=<list>... all attributes except those complex attributes with a minimum cardinality of zero that are not conditionally mandatory and that are part of the "default exclude set" defined in the present specification for the particular resource, but that are not part of <list> Additionally it admits some administrator values: FORCE: To force operations skipping dependency checkings ADMIN: To act as an administrator or a different project PUBLIC: To get public descriptors or set a descriptor as public SET_PROJECT: To make a descriptor available for other project Header field name Reference Example Descriptions Accept IETF RFC 7231 [19] application/json Content-Types that are acceptable for the response. This header field shall be present if the response is expected to have a non-empty message body. Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the request. This header field shall be present if the request has a non-empty message body. Authorization IETF RFC 7235 [22] Bearer mF_9.B5f-4.1JqM The authorization token for the request. Details are specified in clause 4.5.3. Range IETF RFC 7233 [21] 1000-2000 Requested range of bytes from a file Header field name Reference Example Descriptions Content-Type IETF RFC 7231 [19] application/json The MIME type of the body of the response. This header field shall be present if the response has a non-empty message body. Location IETF RFC 7231 [19] http://www.example.com/vnflcm/v1/vnf_instances/123 Used in redirection, or when a new resource has been created. This header field shall be present if the response status code is 201 or 3xx. In the present document this header field is also used if the response status code is 202 and a new resource was created. WWW-Authenticate IETF RFC 7235 [22] Bearer realm="example" Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token. Accept-Ranges IETF RFC 7233 [21] bytes Used by the Server to signal whether or not it supports ranges for certain resources. Content-Range IETF RFC 7233 [21] bytes 21010-47021/ 47022 Signals the byte range that is contained in the response, and the total length of the file. Retry-After IETF RFC 7231 [19] Fri, 31 Dec 1999 23:59:59 GMT``` ``` ## Administrative Content Details Loading Loading @@ -233,6 +301,18 @@ URL: /osm GET POST - POST: Add a new sdn. - Example of request content: TODO `/admin/v1/k8sclusters`. (rbac: `k8sclusters`). K8S Clusters to deploy juju bundles or helm packages - GET: Gets k8s clusters - POST: Add a new k8s cluster. - Example of request content: TODO `/admin/v1/k8srepos`. (rbac: `k8srepos`). K8S repository that contains the juju bundles or helm packages - GET: Gets k8s repositories - POST: Add a new k8s repository. - Example of request content: TODO `/admin/v1/sdns/`. (rbac: `sdn_controllers:id`) - GET: Get sdn details Loading @@ -240,6 +320,18 @@ URL: /osm GET POST - Example of sdn edition: TODO - DELETE: Removes sdn. `/admin/v1/k8sclusters/`. (rbac: `k8sclusters:id`) - GET: Get k8sclusters details - PUT/PATCH: Edit k8sclusters. - DELETE: Removes k8sclusters. `/admin/v1/k8srepos/`. (rbac: `k8srepos:id`) - GET: Get k8srepos details - PUT/PATCH: Edit k8srepos. - DELETE: Removes k8srepos. ## PDU Details Physical Data Unit. This is catalogue of physical elements present at some vim_account/s. Deployment of a PNFD/HNFD implies using one of this pdu from the catalogue. Matching from PNFD/HNFD to PDU is done by 'pdu.type' Loading Loading @@ -284,7 +376,7 @@ TBC ## NSLCM Details Network Services Life Ciclo Management Network Services Lifecycle Management `/nslcm/v1/ns_instances_content`. Loading Loading @@ -424,7 +516,7 @@ NetSlice Template descriptor ## NSILCM Details NetSlice Instance Life Cicle Management NetSlice Instance Lifecycle Management `/nsilcm/v1/netslice_instances_content` Loading
Felipe Vicens <felipe.vicens@atos.net>