From 60e2ee99de20cc9c822647da835c62be514dd3db Mon Sep 17 00:00:00 2001 From: garciadeblas Date: Tue, 27 Feb 2018 19:09:51 +0100 Subject: [PATCH] First commit with API for NS packages and Apache2 license file Change-Id: I760e7cdd709f274e34a9167e690d4eb798966797 Signed-off-by: garciadeblas --- LICENSE | 201 +++++++++++++++++ osm-openapi.yaml | 573 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 774 insertions(+) create mode 100644 LICENSE create mode 100644 osm-openapi.yaml diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/osm-openapi.yaml b/osm-openapi.yaml new file mode 100644 index 0000000..d8d8439 --- /dev/null +++ b/osm-openapi.yaml @@ -0,0 +1,573 @@ +openapi: 3.0.0 +servers: + - description: OSM NB API + url: https://osm.etsi.org/nbapi/v1.0.0 +info: + description: | + This is Open Source MANO Northbound API featuring ETSI NFV SOL005. + For more information on OSM, you can visit + [http://osm.etsi.org](http://osm.etsi.org) or connect to IRCs + [Freenode, #etsi-osm](http://webchat.freenode.net?channels=etsi-osm) or on + [OSM IRC, #tech](https://osm.etsi.org:8080/kiwi) + version: "1.0.0" + title: OSM NB API featuring ETSI NFV SOL005 + contact: + email: OSM_TECH@list.etsi.org + license: + name: Apache 2.0 + url: 'http://www.apache.org/licenses/LICENSE-2.0.html' +tags: + - name: 'VNF packages' + description: Management operations of VNF descriptors and packages + - name: 'NS packages' + description: Management operations of NS descriptors and packages + - name: 'NS instances' + description: Management operations of NS instances +paths: + /nsd/v1/ns_descriptors: + get: + tags: + - "NS packages" + summary: Query information about multiple NS descriptor resources + description: Query information about multiple NS descriptor resources + operationId: getNSDs + security: + - bearerAuth: [] + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayOfNsdInfo' + application/yaml: + schema: + $ref: '#/components/schemas/ArrayOfNsdInfo' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + post: + tags: + - "NS packages" + summary: Create a new NS descriptor resource + description: Create a new NS descriptor resource + operationId: addNSD + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/CreateNsdInfoRequest' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/NsdInfo' + application/yaml: + schema: + $ref: '#/components/schemas/NsdInfo' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + '/nsd/v1/ns_descriptors/{nsdInfoId}': + get: + tags: + - "NS packages" + summary: Read information about an individual NS descriptor resource + description: Read information about an individual NS descriptor resource + operationId: getNSD + security: + - bearerAuth: [] + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NsdInfo' + application/yaml: + schema: + $ref: '#/components/schemas/NsdInfo' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + delete: + tags: + - "NS packages" + summary: Delete an individual NS descriptor resource + description: Delete an individual NS descriptor resource + operationId: deleteNSD + security: + - bearerAuth: [] + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + patch: + tags: + - "NS packages" + summary: Modify the operational state and/or the user defined data of an individual NS descriptor resource + description: Modify the operational state and/or the user defined data of an individual NS descriptor resource + operationId: updateNSD + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/NsdInfoModifications' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NsdInfoModifications' + application/yaml: + schema: + $ref: '#/components/schemas/NsdInfoModifications' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + '/nsd/v1/ns_descriptors/{nsdInfoId}/nsd_content': + get: + tags: + - "NS packages" + summary: Fetch the content of a NSD + description: Fetch the content of a NSD + operationId: getNSDcontent + security: + - bearerAuth: [] + responses: + '200': + description: OK + $ref: '#/components/requestBodies/NsdContent' + '206': + description: Partial Content + headers: + Content-Range: + schema: + type: string + $ref: '#/components/requestBodies/NsdContent' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' + put: + tags: + - "NS packages" + summary: Upload the content of a NSD + description: Upload the content of a NSD + operationId: updateNSDcontent + security: + - bearerAuth: [] + requestBody: + $ref: '#/components/requestBodies/NsdContent' + responses: + '202': + description: Accepted + '204': + description: No Content + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/NotFound' + '405': + $ref: '#/components/responses/MethodNotAllowed' + '406': + $ref: '#/components/responses/NotAcceptable' + '409': + $ref: '#/components/responses/Conflict' + '422': + $ref: '#/components/responses/UnprocessableEntity' + '500': + $ref: '#/components/responses/InternalServerError' + '503': + $ref: '#/components/responses/ServiceUnavailable' + '5XX': + $ref: '#/components/responses/UnexpectedError' + default: + $ref: '#/components/responses/UnexpectedError' +externalDocs: + description: Find out more OSM + url: 'http://osm.etsi.org/wikipub' +components: + responses: + BadRequest: + description: Bad request. The server cannot process the request due to a client error. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + Unauthorized: + description: Authorization information is missing or invalid. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + Forbidden: + description: Not enough permissions to do this operation. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + NotFound: + description: The specified resource was not found. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + MethodNotAllowed: + description: This method is not supported for the requested resource. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + NotAcceptable: + description: The requested resource content cannot match the Accept headers sent in the request. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + Conflict: + description: The operation cannot be executed currently, due to a conflict with the state of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + UnprocessableEntity: + description: The request was well-formed but was unable to be followed due to semantic errors. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + InternalServerError: + description: Internal server error. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + ServiceUnavailable: + description: Service temporarily unavailable. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + UnexpectedError: + description: Unexpected error. + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + schemas: + NsDescriptor: + type: string + NsPackage: + type: string + format: binary + userDefinedData: + type: object + additionalProperties: + type: string + CreateNsdInfoRequest: + type: object + properties: + userDefinedData: + $ref: '#/components/schemas/userDefinedData' + NsdOnboardingStateType: + type: string + enum: [CREATED, UPLAODING, PROCESSING, ONBOARDED] + description: | + NSD onboarding state: + * `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. + NsdOperationalStateType: + type: string + enum: [ENABLED, DISABLED] + description: | + NSD operational state: + * `ENABLED` - The NSD is enabled. + * `ENABLED` - The NSD is disabled. + NsdUsageStateType: + type: string + enum: [IN_USE, NOT_IN_USE] + description: | + NSD operational state: + * `IN_USE` - The NSD is in use. + * `NOT_IN_USE` - The NSD is not in use. + NsdInfoModifications: + type: object + properties: + nsdOperationalState: + $ref: '#/components/schemas/NsdOperationalStateType' + userDefinedData: + $ref: '#/components/schemas/userDefinedData' + NsdInfo: + type: object + properties: + id: + description: | + Identifier of the onboarded individual NS descriptor + resource. This identifier is allocated by the NFVO. + type: string + format: uuid + nsdId: + description: | + This identifier, which is allocated by the NSD + designer, identifies the NSD in a globally unique + way. It is copied from the NSD content and shall be + present after the NSD content is on-boarded. + type: string + format: uuid + nsdName: + description: | + Name of the onboarded NSD. This information is + copied from the NSD content and shall be present + after the NSD content is on-boarded. + type: string + nsdVersion: + description: | + Version of the on-boarded NSD. This information is + copied from the NSD content and shall be present + after the NSD content is on-boarded. + type: string + nsdDesigner: + 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. + type: string + nsdInvariantId: + description: | + This identifier, which is allocated by the NSD designer, + identifies an NSD in a version independent manner. This + information is copied from the NSD content and shall be + present after the NSD content is on-boarded. + type: string + vnfPkgIds: + description: | + List of VNF package identifiers referenced by the on-boarded + NS descriptor resource. + type: array + items: + type: string + format: uuid + pnfdInfoIds: + description: | + List of PNFD identifiers referenced by the on-boarded NS + descriptor resource. + type: array + items: + type: string + format: uuid + nestedNsdInfoIds: + description: | + List of NSD identifiers referenced by the on-boarded NS + descriptor resource. + type: array + items: + type: string + format: uuid + nsdOnboardingState: + $ref: '#components/schemas/NsdOnboardingStateType' + onboardingFailureDetails: + $ref: '#/components/schemas/ProblemDetails' + nsdOperationalState: + $ref: '#components/schemas/NsdOperationalStateType' + nsdUsagestate: + $ref: '#components/schemas/NsdUsageStateType' + userDefinedData: + $ref: '#/components/schemas/userDefinedData' + self: + type: string + format: uri + nsd_content: + type: string + format: uri + required: + - id + ArrayOfNsdInfo: + type: array + items: + $ref: '#/components/schemas/NsdInfo' + # Problem details as described in RFC 7807. + # Optional fields "type" and "instance", as described in RFC 7807 are not used here. + ProblemDetails: + type: object + properties: + type: + type: string + format: uri + title: + type: string + status: + type: integer + detail: + type: string + instance: + type: string + format: uri + additionalProperties: true + required: + - status + - detail + requestBodies: + CreateNsdInfoRequest: + content: + application/json: + schema: + $ref: '#/components/schemas/CreateNsdInfoRequest' + application/yaml: + schema: + $ref: '#/components/schemas/CreateNsdInfoRequest' + NsdInfoModifications: + content: + application/json: + schema: + $ref: '#/components/schemas/NsdInfoModifications' + application/yaml: + schema: + $ref: '#/components/schemas/NsdInfoModifications' + NsdContent: + content: + text/plain: + schema: + $ref: '#/components/schemas/NsDescriptor' + application/zip: + schema: + $ref: '#/components/schemas/NsPackage' + securitySchemes: + bearerAuth: + type: http + scheme: bearer + -- 2.17.1