modify the response 200 of /namespace endpoint (f4fab12f) · Commits · MEC - Multi-access Edge Computing / ETSI MEC Sandbox

examples/demo6/golang/client/api/swagger.yaml

+88 −48

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@ info:
		license:
		name: BSD-3-Clause
		url: https://forge.etsi.org/legal-matters
		version: 0.0.7
		version: 0.0.9
		servers:
		- url: http://localhost/sandbox-api/v1
		paths:
		@@ -29,14 +29,45 @@ paths:
		type: string
		enum:
		- GITHUB
		- GITLAB (EOL ACCOUNT)
		responses:
		"201":
		description: Created
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/Sandbox'
		$ref: '#/components/schemas/Oauth'
		"400":
		description: Bad Request
		content: {}
		"401":
		description: Unauthorized
		content: {}
		"404":
		description: Not Found
		content: {}
		/namespace:
		get:
		tags:
		- Authorization
		summary: Get the namespace against the User Code
		description: Get the namespace against the User Code
		operationId: GetNamespace
		parameters:
		- name: user_code
		in: query
		description: User Code obtained from the login endpoint
		required: true
		style: form
		explode: true
		schema:
		type: string
		responses:
		"200":
		description: This status code indicates that the request has succeeded.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/Namespace'
		"400":
		description: Bad Request
		content: {}
		@@ -394,7 +425,7 @@ paths:
		schema:
		type: array
		items:
		$ref: '#/components/schemas/SandboxAppInstances'
		$ref: '#/components/schemas/ApplicationInfo'
		x-content-type: application/json
		"400":
		description: "Bad Request : used to indicate that incorrect parameters were\
		@@ -1014,8 +1045,9 @@ components:
		- DC
		isExternal:
		type: boolean
		description: "true: Physical location is external to MEEP\nfalse: Physical\
		\ location is internal to MEEP"
		description: \|-
		true: Physical location is external to MEEP
		false: Physical location is internal to MEEP
		geoData:
		$ref: '#/components/schemas/GeoData'
		networkLocationsInRange:
		@@ -1025,17 +1057,24 @@ components:
		description: Names of network locations within range of physical location
		connected:
		type: boolean
		description: "true: Physical location has network connectivity\nfalse: Physical\
		\ location has no network connectivity"
		description: \|-
		true: Physical location has network connectivity
		false: Physical location has no network connectivity
		wireless:
		type: boolean
		description: "true: Physical location uses a wireless connection\nfalse:\
		\ Physical location uses a wired connection"
		description: \|-
		true: Physical location uses a wireless connection
		false: Physical location uses a wired connection
		wirelessType:
		type: string
		description: "Prioritized, comma-separated list of supported wireless connection\
		\ types.\nDefault priority if not specififed is 'wifi,5g,4g,other'.\n\
		Wireless connection types:\n- 4g\n- 5g\n- wifi\n- other"
		description: \|-
		Prioritized, comma-separated list of supported wireless connection types.
		Default priority if not specififed is 'wifi,5g,4g,other'.
		Wireless connection types:
		- 4g
		- 5g
		- wifi
		- other
		dataNetwork:
		$ref: '#/components/schemas/DNConfig'
		meta:
		@@ -1081,8 +1120,9 @@ components:
		description: Data Network Name
		ladn:
		type: boolean
		description: "true: Data network serves local area only\nfalse: Data network\
		\ is not limited to local area"
		description: \|-
		true: Data network serves local area only
		false: Data network is not limited to local area
		ecsp:
		type: string
		description: Edge Compute Service Provider
		@@ -1107,8 +1147,9 @@ components:
		- CLOUD-APP
		isExternal:
		type: boolean
		description: "true: process is external to MEEP\nfalse: process is internal\
		\ to MEEP"
		description: \|-
		true: process is external to MEEP
		false: process is internal to MEEP
		image:
		type: string
		description: Docker image to deploy inside MEEP
		@@ -1250,8 +1291,9 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/EgressService'
		description: "External Process configuration.\nNOTE: Only valid if 'isExternal'\
		\ is set."
		description: \|-
		External Process configuration.
		NOTE: Only valid if 'isExternal' is set.
		example: {}
		IngressService:
		type: object
		@@ -1346,16 +1388,32 @@ components:
		example:
		subscriptionReference: "[\"37dd7ef4-c382-11ee-9301-5fe5aa3a97cf\"]"
		callbackReference: "[\"http://my.callback.com/sandbox/logs/some-id\"]"
		Sandbox:
		Oauth:
		type: object
		properties:
		name:
		user_code:
		type: string
		description: Sandbox name
		description: User code from the authentication provider
		x-etsi-mec-cardinality: "1"
		x-etsi-mec-origin-type: String
		verification_uri:
		type: string
		description: Verification URI to go to and enter the user code in order
		to authenticate
		x-etsi-mec-cardinality: "1"
		x-etsi-mec-origin-type: String
		description: Sandbox object
		example: {}
		Namespace:
		type: object
		properties:
		sandbox_name:
		type: string
		description: Name of the Sandbox
		x-etsi-mec-cardinality: "1"
		x-etsi-mec-origin-type: String
		description: Namespace object
		example: {}
		ProblemDetails:
		required:
		- detail
		@@ -1364,26 +1422,17 @@ components:
		properties:
		type:
		type: string
		description: "A URI reference according to IETF RFC 3986 that identifies\
		\ the problem type. It is encouraged that the URI provides human-readable\
		\ documentation for the problem (e.g. using HTML) when dereferenced. When\
		\ this member is not present, its value is assumed to be \"about:blank\"\
		.\n"
		description: \|
		A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
		format: URI
		title:
		type: string
		description: "A short, human-readable summary of the problem type. It should\
		\ not change from occurrence to occurrence of the problem, except for\
		\ purposes of localization. If type is given and other than \"about:blank\"\
		, this attribute shall also be provided. A short, human-readable summary\
		\ of the problem type. It SHOULD NOT change from occurrence to occurrence\
		\ of the problem, except for purposes of localization (e.g., using proactive\
		\ content negotiation; see [RFC7231], Section 3.4).\n"
		description: \|
		A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
		status:
		type: integer
		description: "The HTTP status code for this occurrence of the problem. The\
		\ HTTP status code ([RFC7231], Section 6) generated by the origin server\
		\ for this occurrence of the problem.\n"
		description: \|
		The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
		detail:
		type: string
		description: \|
		@@ -1393,17 +1442,8 @@ components:
		description: \|
		A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
		format: URI
		description: "The definition of the general \"ProblemDetails\" data structure\
		\ from IETF RFC 7807 is reproduced inthis structure. Compared to the general\
		\ framework defined in IETF RFC 7807, the \"status\" and \"detail\" attributes\
		\ are mandated to be included by the present document, to ensure that the\
		\ response contains additional textual information about an error. IETF RFC\
		\ 7807 foresees extensibility of the \"ProblemDetails\" type. It is possible\
		\ that particular APIs in the present document, or particular implementations,\
		\ define extensions to define additional attributes that provide more information\
		\ about the error. The description column only provides some explanation of\
		\ the meaning to Facilitate understanding of the design. For a full description,\
		\ see IETF RFC 7807.\n"
		description: \|
		The definition of the general "ProblemDetails" data structure from IETF RFC 7807 is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807, the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807.
		example:
		instance: instance
		detail: detail

go-apps/meep-sandbox-api/api/swagger.yaml

+60 −48

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@ info:
		license:
		name: BSD-3-Clause
		url: https://forge.etsi.org/legal-matters
		version: 0.0.8
		version: 0.0.9
		servers:
		- url: http://localhost/sandbox-api/v1
		paths:
		@@ -35,7 +35,7 @@ paths:
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/Sandbox'
		$ref: '#/components/schemas/Oauth'
		"400":
		description: Bad Request
		content: {}
		@@ -63,8 +63,11 @@ paths:
		type: string
		responses:
		"200":
		description: OK
		content: {}
		description: This status code indicates that the request has succeeded.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/Namespace'
		"400":
		description: Bad Request
		content: {}
		@@ -1042,8 +1045,9 @@ components:
		- DC
		isExternal:
		type: boolean
		description: "true: Physical location is external to MEEP\nfalse: Physical\
		\ location is internal to MEEP"
		description: \|-
		true: Physical location is external to MEEP
		false: Physical location is internal to MEEP
		geoData:
		$ref: '#/components/schemas/GeoData'
		networkLocationsInRange:
		@@ -1053,17 +1057,24 @@ components:
		description: Names of network locations within range of physical location
		connected:
		type: boolean
		description: "true: Physical location has network connectivity\nfalse: Physical\
		\ location has no network connectivity"
		description: \|-
		true: Physical location has network connectivity
		false: Physical location has no network connectivity
		wireless:
		type: boolean
		description: "true: Physical location uses a wireless connection\nfalse:\
		\ Physical location uses a wired connection"
		description: \|-
		true: Physical location uses a wireless connection
		false: Physical location uses a wired connection
		wirelessType:
		type: string
		description: "Prioritized, comma-separated list of supported wireless connection\
		\ types.\nDefault priority if not specififed is 'wifi,5g,4g,other'.\n\
		Wireless connection types:\n- 4g\n- 5g\n- wifi\n- other"
		description: \|-
		Prioritized, comma-separated list of supported wireless connection types.
		Default priority if not specififed is 'wifi,5g,4g,other'.
		Wireless connection types:
		- 4g
		- 5g
		- wifi
		- other
		dataNetwork:
		$ref: '#/components/schemas/DNConfig'
		meta:
		@@ -1109,8 +1120,9 @@ components:
		description: Data Network Name
		ladn:
		type: boolean
		description: "true: Data network serves local area only\nfalse: Data network\
		\ is not limited to local area"
		description: \|-
		true: Data network serves local area only
		false: Data network is not limited to local area
		ecsp:
		type: string
		description: Edge Compute Service Provider
		@@ -1135,8 +1147,9 @@ components:
		- CLOUD-APP
		isExternal:
		type: boolean
		description: "true: process is external to MEEP\nfalse: process is internal\
		\ to MEEP"
		description: \|-
		true: process is external to MEEP
		false: process is internal to MEEP
		image:
		type: string
		description: Docker image to deploy inside MEEP
		@@ -1278,8 +1291,9 @@ components:
		type: array
		items:
		$ref: '#/components/schemas/EgressService'
		description: "External Process configuration.\nNOTE: Only valid if 'isExternal'\
		\ is set."
		description: \|-
		External Process configuration.
		NOTE: Only valid if 'isExternal' is set.
		example: {}
		IngressService:
		type: object
		@@ -1374,16 +1388,32 @@ components:
		example:
		subscriptionReference: "[\"37dd7ef4-c382-11ee-9301-5fe5aa3a97cf\"]"
		callbackReference: "[\"http://my.callback.com/sandbox/logs/some-id\"]"
		Sandbox:
		Oauth:
		type: object
		properties:
		name:
		user_code:
		type: string
		description: Sandbox name
		description: User code from the authentication provider
		x-etsi-mec-cardinality: "1"
		x-etsi-mec-origin-type: String
		verification_uri:
		type: string
		description: Verification URI to go to and enter the user code in order
		to authenticate
		x-etsi-mec-cardinality: "1"
		x-etsi-mec-origin-type: String
		description: Sandbox object
		example: {}
		Namespace:
		type: object
		properties:
		sandbox_name:
		type: string
		description: Name of the Sandbox
		x-etsi-mec-cardinality: "1"
		x-etsi-mec-origin-type: String
		description: Namespace object
		example: {}
		ProblemDetails:
		required:
		- detail
		@@ -1392,26 +1422,17 @@ components:
		properties:
		type:
		type: string
		description: "A URI reference according to IETF RFC 3986 that identifies\
		\ the problem type. It is encouraged that the URI provides human-readable\
		\ documentation for the problem (e.g. using HTML) when dereferenced. When\
		\ this member is not present, its value is assumed to be \"about:blank\"\
		.\n"
		description: \|
		A URI reference according to IETF RFC 3986 that identifies the problem type. It is encouraged that the URI provides human-readable documentation for the problem (e.g. using HTML) when dereferenced. When this member is not present, its value is assumed to be "about:blank".
		format: URI
		title:
		type: string
		description: "A short, human-readable summary of the problem type. It should\
		\ not change from occurrence to occurrence of the problem, except for\
		\ purposes of localization. If type is given and other than \"about:blank\"\
		, this attribute shall also be provided. A short, human-readable summary\
		\ of the problem type. It SHOULD NOT change from occurrence to occurrence\
		\ of the problem, except for purposes of localization (e.g., using proactive\
		\ content negotiation; see [RFC7231], Section 3.4).\n"
		description: \|
		A short, human-readable summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization. If type is given and other than "about:blank", this attribute shall also be provided. A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
		status:
		type: integer
		description: "The HTTP status code for this occurrence of the problem. The\
		\ HTTP status code ([RFC7231], Section 6) generated by the origin server\
		\ for this occurrence of the problem.\n"
		description: \|
		The HTTP status code for this occurrence of the problem. The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
		detail:
		type: string
		description: \|
		@@ -1421,17 +1442,8 @@ components:
		description: \|
		A URI reference that identifies the specific occurrence of the problem. It may yield further information if dereferenced.
		format: URI
		description: "The definition of the general \"ProblemDetails\" data structure\
		\ from IETF RFC 7807 is reproduced inthis structure. Compared to the general\
		\ framework defined in IETF RFC 7807, the \"status\" and \"detail\" attributes\
		\ are mandated to be included by the present document, to ensure that the\
		\ response contains additional textual information about an error. IETF RFC\
		\ 7807 foresees extensibility of the \"ProblemDetails\" type. It is possible\
		\ that particular APIs in the present document, or particular implementations,\
		\ define extensions to define additional attributes that provide more information\
		\ about the error. The description column only provides some explanation of\
		\ the meaning to Facilitate understanding of the design. For a full description,\
		\ see IETF RFC 7807.\n"
		description: \|
		The definition of the general "ProblemDetails" data structure from IETF RFC 7807 is reproduced inthis structure. Compared to the general framework defined in IETF RFC 7807, the "status" and "detail" attributes are mandated to be included by the present document, to ensure that the response contains additional textual information about an error. IETF RFC 7807 foresees extensibility of the "ProblemDetails" type. It is possible that particular APIs in the present document, or particular implementations, define extensions to define additional attributes that provide more information about the error. The description column only provides some explanation of the meaning to Facilitate understanding of the design. For a full description, see IETF RFC 7807.
		example:
		instance: instance
		detail: detail