diff --git a/build.sh b/build.sh index da9fc7a2a2203c47f09508186c2c7b4eff88b10e..2f69bca291d469f6d8ce402c1bf35ccefd510d7b 100755 --- a/build.sh +++ b/build.sh @@ -4,7 +4,7 @@ SCRIPT=$(readlink -f "$0") BASEDIR=$(dirname "$SCRIPT") -MEEPDIR=~/AdvantEDGE +MEEPDIR=~/etsi-mec-sandbox install_package() { echo "" diff --git a/config/api/capif-mgmt.yaml b/config/api/capif-mgmt.yaml index 56ca96771c9250f87cb12bd579eff2d18236d849..d823b211707ef70e072ceed8c39c959e3862e9b0 100644 --- a/config/api/capif-mgmt.yaml +++ b/config/api/capif-mgmt.yaml @@ -29,26 +29,28 @@ paths: get: tags: - services - description: This method retrieves information about a list of mecService resources. - This method is typically used in "service availability query" procedure + description: | + This method retrieves information about a list of mecService resources. + This method is typically used in the "service availability query" procedure. + **Example:** Retrieve all available services with specific parameters for filtering. operationId: Services_GET parameters: - name: vend-spec-etsi-mec-serinstance-id in: query - description: Vendor-specific query parameter for service instance ID. The - "target" attribute shall be set to "/apiId". + description: | + Vendor-specific query parameter for service instance ID. The "target" attribute shall be set to "/apiId". + **Example:** {\"target\": \"/apiId\", \"value\": \"serviceInstanceId\"} required: false style: form explode: true schema: type: string - example: "{\"target\": \"/apiId\", \"value\": \"serviceInstanceId\"}" - name: api-name in: query - description: "This query parameter corresponds to the parameter \"ser_name\"\ - \ as defined in clause 8.2.3.3.1. As opposed to the cardinality of ser_instance_id\ - \ defined in clause 8.2.3.3.1 that is 0..N, this parameter only supports\ - \ a cardinality of 0..1." + description: | + This query parameter corresponds to the parameter "ser_name" as defined in clause 8.2.3.3.1. + As opposed to the cardinality of ser_instance_id defined in clause 8.2.3.3.1 that is 0..N, this parameter only supports a cardinality of 0..1. + **Example:** ["ServiceName1"] required: false style: form explode: true @@ -58,11 +60,10 @@ paths: type: string - name: api-invoker-id in: query - description: "If the Discover_Service_API is produced by the MEC platform\ - \ towards the MEC applications, this identifier shall be set to the value\ - \ of the \"appInstanceId\" (see clause 7.1.2.6). If the Discover_Service_API\ - \ is produced by the CCF, the provisions in clause 8.1.2.2.3.1 of 3GPP TS\ - \ 29.222 [21] apply. " + description: | + If the Discover_Service_API is produced by the MEC platform towards the MEC applications, this identifier shall be set to the value of the "appInstanceId" (see clause 7.1.2.6). + If the Discover_Service_API is produced by the CCF, the provisions in clause 8.1.2.2.3.1 of 3GPP TS 29.222 [21] apply. + **Example:** "InvokerAppInstanceId" required: false style: form explode: true @@ -70,52 +71,49 @@ paths: type: string - name: vend-spec-etsi-mec-sercategory-id in: query - description: Vendor-specific query parameter for service category ID. The - "target" attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/serCategory/id". + description: | + Vendor-specific query parameter for service category ID. The "target" attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/serCategory/id". + **Example:** {\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/serCategory/id\", \"value\": \"serviceCategoryId\"} required: false style: form explode: true schema: type: string - example: "{\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/serCategory/id\"\ - , \"value\": \"serviceCategoryId\"}" - name: vend-spec-etsi-mec-consumed-local-only in: query - description: Vendor-specific query parameter for consumed local only. The - "target" attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/consumedLocalOnly". + description: | + Vendor-specific query parameter for consumed local only. The "target" attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/consumedLocalOnly". + **Example:** {\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/consumedLocalOnly\", \"value\": \"true\"} required: false style: form explode: true schema: type: string - example: "{\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/consumedLocalOnly\"\ - , \"value\": \"true\"}" - name: vend-spec-etsi-mec-is-local in: query - description: Vendor-specific query parameter for is local. The "target" attribute - shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/isLocal". + description: | + Vendor-specific query parameter for is local. The "target" attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/isLocal". + **Example:** {\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/isLocal\", \"value\": \"true\"} required: false style: form explode: true schema: type: string - example: "{\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/isLocal\"\ - , \"value\": \"true\"}" - name: vend-spec-etsi-mec-scope-of-locality in: query - description: Vendor-specific query parameter for scope of locality. The "target" - attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/scopeOfLocality". + description: | + Vendor-specific query parameter for scope of locality. The "target" attribute shall be set to "/vendorSpecific-urn:etsi:mec:capifext:service-info/scopeOfLocality". + **Example:** {\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/scopeOfLocality\", \"value\": \"scopeOfLocalityValue\"} required: false style: form explode: true schema: type: string - example: "{\"target\": \"/vendorSpecific-urn:etsi:mec:capifext:service-info/scopeOfLocality\"\ - , \"value\": \"scopeOfLocalityValue\"}" responses: "200": description: | The response body contains the result of the search over the list of registered APIs. + **Example:** JSON array of discovered APIs with details like "apiId", "serName", "scopeOfLocality", etc. content: application/json: schema: @@ -123,10 +121,10 @@ paths: "307": description: | Temporary redirection. The response shall include a Location header field containing an alternative target URI of the resource located in an alternative CCF. + **Example:** "https://alternative-ccf.example.com/resource" headers: Location: - description: Contains an alternative target URI of the resource located - in an alternative CCF. + description: Contains an alternative target URI of the resource located in an alternative CCF. style: simple explode: false schema: @@ -134,39 +132,42 @@ paths: "308": description: | Permanent redirection. The response shall include a Location header field containing an alternative target URI of the resource located in an alternative CCF. + **Example:** "https://permanent-ccf.example.com/resource" headers: Location: - description: Contains an alternative target URI of the resource located - in an alternative CCF. + description: Contains an alternative target URI of the resource located in an alternative CCF. style: simple explode: false schema: type: string "400": - description: Bad Request. It is used to indicate that incorrect parameters - were passed to the request. + description: | + Bad Request. It is used to indicate that incorrect parameters were passed to the request. + **Example:** Invalid "vend-spec-etsi-mec-serinstance-id" format. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "403": - description: Forbidden. The operation is not allowed given the current status - of the resource. + description: | + Forbidden. The operation is not allowed given the current status of the resource. + **Example:** Access restricted to registered users only. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "404": - description: Not Found. It is used when a client provided a URI that cannot - be mapped to a valid resource URI. + description: | + Not Found. It is used when a client provided a URI that cannot be mapped to a valid resource URI. + **Example:** Non-existent service identifier provided in the URI. content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' "414": - description: It is used to indicate that the server is refusing to process - the request because the request URI is longer than the server is willing - or able to process. + description: | + Request URI Too Long. Indicates that the server is refusing to process the request because the URI is too long. + **Example:** Excessive query parameters length in the request URI. content: application/problem+json: schema: diff --git a/deploy.sh b/deploy.sh index f8a873bbeff1d5f3767c8e22c3255cce35af8f0e..dc261199ba5b1605b8231a40f75cd99c929045e5 100755 --- a/deploy.sh +++ b/deploy.sh @@ -4,7 +4,7 @@ SCRIPT=$(readlink -f "$0") BASEDIR=$(dirname "$SCRIPT") -MEEPDIR=~/AdvantEDGE +MEEPDIR=~/etsi-mec-sandbox CONFIGDIR=$MEEPDIR/config DASHBOARDDIR=$MEEPDIR/charts/grafana/dashboards APIDIR=$MEEPDIR/config/api