From cf469f63cb490d90b55508efa331073a17297999 Mon Sep 17 00:00:00 2001 From: MatthieuGeerebaert Date: Tue, 12 Mar 2019 18:30:33 +0100 Subject: Update Swagger files Change-Id: I02a375b4998fdf23bd7c4eb391011a8e37a1c8e2 Issue-ID: EXTAPI-211 Signed-off-by: MatthieuGeerebaert --- .../serviceInventory/documentation.html | 1432 -------------------- 1 file changed, 1432 deletions(-) delete mode 100644 docs/offeredapis/serviceInventory/documentation.html (limited to 'docs/offeredapis/serviceInventory/documentation.html') diff --git a/docs/offeredapis/serviceInventory/documentation.html b/docs/offeredapis/serviceInventory/documentation.html deleted file mode 100644 index f7fb115..0000000 --- a/docs/offeredapis/serviceInventory/documentation.html +++ /dev/null @@ -1,1432 +0,0 @@ - - - - - - - -API ServiceInventory - - - - - -
-
-

Overview

-
-
-

Api URL

-
-

Swagger UI

-
-
-

plant UML UI

-
-
-

serviceInventory API designed for ONAP Beijing Release. -This API is build from TMF open API18.0 (applying TMF Guideline 3.0) -only operation GET (by id & byList) for resource serviceSpecification is available

-
-
-
-

Version information

-
-

Version : 3.0.0_inProgress

-
-
-
-

URI scheme

-
-

Host : serverRoot
-BasePath : /nbi/api/v3
-Schemes : HTTPS

-
-
-
-

Tags

-
-
    -
  • -

    Service

    -
    • -
-
-
-
-

Produces

-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-

Resources

-
-
-

Service

-
-

List services

-
-
-
GET /service
-
-
-
-
Description
-
-

This operation list service entities. -Attribute selection is restricted. -fields attribute may be used to filter retrieved attribute(s) for each service

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameSchema

Query

fields
-optional

string

Query

id
-optional

string

Query

relatedParty.id
-optional

string

Query

serviceSpecification.id
-optional

string

Query

serviceSpecification.name
-optional

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

< ListService > array

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-

Retrieve a service

-
-
-
GET /service/{id}
-
-
-
-
Description
-
-

This operation retrieves a service entity. -Attribute selection is enabled for all first level attributes.

-
-
-

Specific business errors for current operation will be encapsulated in

-
-
-

HTTP Response 422 Unprocessable entity

-
-
-
-
Parameters
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TypeNameSchema

Path

id
-required

string

Query

relatedParty.id
-optional

string

Query

serviceSpecification.id
-optional

string

Query

serviceSpecification.name
-optional

string

-
-
-
Responses
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
HTTP CodeDescriptionSchema

200

Success

Service

400

Bad Request

-

List of supported error codes: -- 20: Invalid URL parameter value -- 21: Missing body -- 22: Invalid body -- 23: Missing body field -- 24: Invalid body field -- 25: Missing header -- 26: Invalid header value -- 27: Missing query-string parameter -- 28: Invalid query-string parameter value

ErrorRepresentation

401

Unauthorized

-

List of supported error codes: -- 40: Missing credentials -- 41: Invalid credentials -- 42: Expired credentials

ErrorRepresentation

403

Forbidden

-

List of supported error codes: -- 50: Access denied -- 51: Forbidden requester -- 52: Forbidden user -- 53: Too many requests

ErrorRepresentation

404

Not Found

-

List of supported error codes: -- 60: Resource not found

ErrorRepresentation

422

Unprocessable entity

-

Functional error

ErrorRepresentation

500

Internal Server Error

-

List of supported error codes: -- 1: Internal error

ErrorRepresentation

503

Service Unavailable

-

List of supported error codes: -- 5: The service is temporarily unavailable -- 6: Orange API is over capacity, retry later !

ErrorRepresentation

-
-
-
Produces
-
-
    -
  • -

    application/json;charset=utf-8

    -
    • -
-
-
-
-
-
-
-
-

Definitions

-
-
-

ErrorRepresentation

-
-

This class is used to describe error. -for nbi Beijing release we do not manage additional error for serviceCatalog

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

it provides a link to the schema describing a REST resource.

string

@type
-optional

The class type of a REST resource.

string

code
-required

Application related code (as defined in the API or from a common list)

integer (int32)

message
-optional

Text that provide more details and corrective actions related to the error. This can be shown to a client user.

string

reason
-required

Text that explains the reason for error. This can be shown to a client user.

string

referenceError
-optional

url pointing to documentation describing the error

string

status
-optional

http error code extension like 400-2

string

-
-
-

ListRelatedPartyRef

-
-

This class is used to structure list of service(s) retrieved

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of a related party

string

role
-optional

Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.

string

-
-
-

ListService

-
-

This class is used to structure list of service(s) retrieved

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of the service

string

name
-optional

Name of the service

string

relatedParty
-optional

ListRelatedPartyRef

serviceSpecification
-optional

ListServiceSpecificationRef

-
-
-

ListServiceSpecificationRef

-
-

This class is used to structure list of service(s) retrieved

-
- ----- - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

id
-optional

Unique identifier of the service specification

string

name
-optional

Name of the required service specification

string

-
-
-

RelatedPartyRef

-
-

RelatedParty reference. A related party defines party or party role linked to a specific entity. -Only ONAP Customer is managed in Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

Not managed in the Beijing release.

string

href
-optional

Reference of a related party. -Not filled in Beijing release.

string

id
-optional

Unique identifier of a related party

string

role
-optional

Role played by the related party. -Filled with 'ONAPcustomer'

string

-
-
-

Service

-
-

Instantiated service (service_instance) in AAI

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@baseType
-optional

Not managed in Beijing release

string

@schemaLocation
-optional

Not managed in Beijing release

string

@type
-optional

This attribute allows to dynamically extends TMF class. Not used in Beijing release.

string

characteristic
-optional

< ServiceCharacteristic > array

hasStarted
-optional

This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started -Not managed in Beijing release

boolean

href
-optional

Reference of the service -Not managed in Beijing release

string

id
-optional

Unique identifier of the service - Valued with service-instance-id

string

name
-optional

Name of the service - Valued with service-instance-name

string

relatedParty
-optional

< RelatedPartyRef > array

serviceSpecification
-optional

ServiceSpecificationRef

state
-optional

State of the service. Not managed in Beijing release

string

supportingResource
-optional

< SupportingResource > array

type
-optional

Service type - valued with 'service-instance'

string

-
-
-

ServiceCharacteristic

-
-

A list of name value pairs that define the service characteristics -Not managed in Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

name
-required

Name of the characteristic -Not managed in Beijing release.

string

value
-optional

Value

valueType
-optional

Type of value for this characteristic. -Not managed in Beijing release.

string

-
-
-

ServiceSpecificationRef

-
-

Service specification reference: ServiceSpecification of this service (catalog information)

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID

string

@schemaLocation
-optional

Not managed in Beijing release

string

href
-optional

Reference of the service specification. -not managed in Beijing release.

string

id
-optional

Unique identifier of the service specification. valued to model-version-id

string

invariantUUID
-optional

Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id

string

name
-optional

Name of the required service specification

string

version
-optional

Service specification version. -Not managed in Beijing release

string

-
-
-

SupportingResource

-
-

Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@referredType
-optional

This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes: - status - modelInvariantId - modelVersionId - modelCustomisationId

string

@schemaLocation
-optional

Not managed in Beijing release.

string

href
-optional

Reference of the supporting resource

string

id
-optional

Unique identifier of the supporting resource - Valued to vnf-id

string

modelCustomisationId
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id

string

modelInvariantId
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id

string

modelVersionId
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id

string

name
-optional

Name of the supporting resource - Valued with vnf_-name

string

role
-optional

Not managed in Beijing release.

string

status
-optional

Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status

string

-
-
-

Value

-
-

Structure used to describe characteristic value. -Not managed in Beijing release.

-
- ----- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescriptionSchema

@schemaLocation
-optional

Not managed in Beijing release.

string

@type
-optional

Not managed in Beijing release.

string

serviceCharacteristicValue
-optional

Not managed in Beijing release.

string

-
-
-
-
- - - \ No newline at end of file -- cgit 1.2.3-korg