Return $metadata resource as odata + openapi spec #528

fisehara · 2022-02-24T23:48:34Z

Returning odata and openapi specs in json format.
Specs are scoped to the request permissions.
Different users (roles) will receive different metadata endpoints
and resources.

Change-type: minor
See: https://jel.ly.fish/thread-93132f4a-1885-43c4-ac8d-1c190052e7d9
See: https://jel.ly.fish/thread-4245cd32-8b76-4c1a-a195-c8615c41b321
Signed-off-by: Harald Fischer [email protected]

fisehara · 2022-07-20T17:22:15Z

FYI @vipulgupta2048

JSReds · 2022-08-26T13:56:25Z

src/sbvr-api/permissions.ts

@@ -312,7 +312,7 @@ const namespaceRelationships = (
 	});
 };

-type PermissionLookup = Dictionary<true | string[]>;
+export type PermissionLookup = _.Dictionary<true | string[]>;


out of curiosity, what is the difference between lodash Dictionary and pinejs-client-core Dictionary ?

@JSReds good catch. thx! This is a mistake. I only needed to export the PermissionLookup and not change the type.
Fixed to not use lodash dictionary.

shaunco · 2023-09-20T19:32:38Z

@fisehara - would love to see this merged. I just set out to build a golang API wrapper for Balena and ran into the lack of $metadata pretty quickly. Exposing the $metadata endpoint would allow OData client generators in a bunch of languages produce clients.

Page- · 2023-11-03T16:50:09Z

src/sbvr-api/sbvr-utils.ts

@@ -1728,6 +1754,8 @@ const respondGet = async (
 	}
 };

+// paths./any/.get.responses.200.content.application/json.schema.d


What is this about?

Noise ;) Deleted.

Page- · 2023-11-03T16:51:39Z

src/odata-metadata/open-api-sepcification-generator.ts

+	 * Used oasis translator generates openapi according to v4 spec (`value: `)
+	 */
+
+	Object.keys(openAPIJson.paths).forEach((i) => {


I prefer a for-of in general:

Suggested change

Object.keys(openAPIJson.paths).forEach((i) => {

for (const i of Object.keys(openAPIJson.paths)) {

Page- · 2023-11-03T16:53:41Z

src/odata-metadata/open-api-sepcification-generator.ts

+		if (
+			openAPIJson?.paths[i]?.get?.responses?.['200']?.content?.[
+				'application/json'
+			]?.schema?.properties?.value
+		) {
+			openAPIJson.paths[i].get.responses['200'].content[
+				'application/json'
+			].schema.properties['d'] =
+				openAPIJson.paths[i].get.responses['200'].content[
+					'application/json'
+				].schema.properties.value;
+			delete openAPIJson.paths[i].get.responses['200'].content[
+				'application/json'
+			].schema.properties.value;
+		}


I prefer the pattern of:

Suggested change

if (

openAPIJson?.paths[i]?.get?.responses?.['200']?.content?.[

'application/json'

]?.schema?.properties?.value

) {

openAPIJson.paths[i].get.responses['200'].content[

'application/json'

].schema.properties['d'] =

openAPIJson.paths[i].get.responses['200'].content[

'application/json'

].schema.properties.value;

delete openAPIJson.paths[i].get.responses['200'].content[

'application/json'

].schema.properties.value;

}

const properties = openAPIJson?.paths[i]?.get?.responses?.['200']?.content?.[

'application/json'

]?.schema?.properties

if (properties?.value) {

properties['d'] = properties.value;

delete properties.value;

}

Returning odata and openapi specs in json format. Specs are scoped to the request permissions. Different users (roles) will receive different metadata endpoints and resources. Change-type: minor Signed-off-by: Harald Fischer <[email protected]>

Signed-off-by: Harald Fischer <[email protected]>

fisehara force-pushed the odata-metadata-json branch 4 times, most recently from 3ce2bb1 to efc396d Compare March 2, 2022 23:00

fisehara changed the title ~~odata-metadata-json endpoint~~ Return $metadata resource as odata + openapi spec Mar 2, 2022

fisehara requested review from Page- and JSReds March 2, 2022 23:00

fisehara force-pushed the odata-metadata-json branch 3 times, most recently from d178dd7 to 1593dfb Compare March 4, 2022 15:13

fisehara mentioned this pull request Mar 4, 2022

Draft: Adding tests for odata and openapi spec metadata balena-io/open-balena-api#973

Closed

fisehara force-pushed the odata-metadata-json branch 2 times, most recently from 08ed3e9 to 79a815c Compare March 8, 2022 18:50

fisehara force-pushed the odata-metadata-json branch 2 times, most recently from 7e03cea to 45841e6 Compare March 21, 2022 08:25

fisehara force-pushed the odata-metadata-json branch from 45841e6 to dcc6fcc Compare March 23, 2022 21:11

fisehara force-pushed the odata-metadata-json branch 2 times, most recently from 54bcbfc to b39bec1 Compare July 20, 2022 16:59

fisehara force-pushed the odata-metadata-json branch 3 times, most recently from ffadb18 to 6e86ce9 Compare August 10, 2022 20:05

fisehara changed the title ~~Return $metadata resource as odata + openapi spec~~ DRAFT: Return $metadata resource as odata + openapi spec Aug 10, 2022

fisehara force-pushed the odata-metadata-json branch 2 times, most recently from dbd8d4b to f70416c Compare August 18, 2022 20:33

fisehara force-pushed the odata-metadata-json branch from f70416c to 8476d71 Compare August 24, 2022 12:58

fisehara changed the title ~~DRAFT: Return $metadata resource as odata + openapi spec~~ Return $metadata resource as odata + openapi spec Aug 24, 2022

fisehara requested a review from thgreasi August 24, 2022 13:01

fisehara force-pushed the odata-metadata-json branch from 8476d71 to 95ecd2c Compare August 26, 2022 12:43

JSReds reviewed Aug 26, 2022

View reviewed changes

fisehara force-pushed the odata-metadata-json branch from 5d1f441 to cf5f0d3 Compare December 9, 2022 17:21

fisehara force-pushed the odata-metadata-json branch 3 times, most recently from da239da to 9b62b0e Compare January 2, 2023 14:58

fisehara marked this pull request as draft January 27, 2023 17:47

fisehara force-pushed the odata-metadata-json branch 3 times, most recently from e2841ca to 83b4198 Compare June 5, 2023 11:06

Page- reviewed Nov 3, 2023

View reviewed changes

fisehara force-pushed the odata-metadata-json branch 9 times, most recently from 78f5a7e to 78b8394 Compare November 9, 2023 23:21

fisehara force-pushed the odata-metadata-json branch from 78b8394 to 505f79b Compare November 30, 2023 20:46

fisehara force-pushed the odata-metadata-json branch 4 times, most recently from 584853e to 25d92ed Compare January 24, 2024 13:04

fisehara force-pushed the odata-metadata-json branch from 25d92ed to f3705bb Compare February 5, 2024 16:15

fisehara force-pushed the odata-metadata-json branch from f3705bb to b2aabe7 Compare February 16, 2024 14:02

fisehara force-pushed the odata-metadata-json branch from b2aabe7 to e4d0c5c Compare November 11, 2024 12:10

fisehara added 2 commits December 6, 2024 12:31

progress after rebase

c589975

Signed-off-by: Harald Fischer <[email protected]>

fisehara force-pushed the odata-metadata-json branch from f4ee366 to c589975 Compare December 6, 2024 11:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Return $metadata resource as odata + openapi spec #528

Return $metadata resource as odata + openapi spec #528

fisehara commented Feb 24, 2022 •

edited by thgreasi

Loading

fisehara commented Jul 20, 2022

JSReds Aug 26, 2022 •

edited

Loading

fisehara Aug 26, 2022

shaunco commented Sep 20, 2023

Page- Nov 3, 2023

fisehara Nov 9, 2023

Page- Nov 3, 2023

Page- Nov 3, 2023

	Object.keys(openAPIJson.paths).forEach((i) => {
	for (const i of Object.keys(openAPIJson.paths)) {

Return $metadata resource as odata + openapi spec #528

Are you sure you want to change the base?

Return $metadata resource as odata + openapi spec #528

Conversation

fisehara commented Feb 24, 2022 • edited by thgreasi Loading

fisehara commented Jul 20, 2022

JSReds Aug 26, 2022 • edited Loading

Choose a reason for hiding this comment

fisehara Aug 26, 2022

Choose a reason for hiding this comment

shaunco commented Sep 20, 2023

Page- Nov 3, 2023

Choose a reason for hiding this comment

fisehara Nov 9, 2023

Choose a reason for hiding this comment

Page- Nov 3, 2023

Choose a reason for hiding this comment

Page- Nov 3, 2023

Choose a reason for hiding this comment

fisehara commented Feb 24, 2022 •

edited by thgreasi

Loading

JSReds Aug 26, 2022 •

edited

Loading