encoding/opeanpi: paths parsing for OpenAPI spec #1727

qequ · 2022-05-20T21:10:42Z

Implemented parsing for paths in cue when interpreting OpenAPI.

parsing functionality of most of the objects of a path as given by swagger spec;

For a Path Item object;
- description,
- all operations (get, post, put, etc).
For a Operation object
- Description
- Responses
- Security
For a Response Object
- description
- content
For a Media Type Object
- schema

Parsing notes;
Instead of using a single paths top declaration object defined "Paths" as suggests #386 each path is written separately as a top decl object withe the prefix " $/ ", similarly as Components Objects are defined using definitions.

If Security is defined as a Path Item object, that Security list will be applied to all the operations

For parsing Media Type Objects schemas, Components Objects schemas parsing functionality was reused

Added unit tests
All tests passed (running go test ./...)

Fixes #386 #735

Update pathBuilder struct

…rations now the paths are checked with a prefix of the form $/ instead of $

…the case of a wrong http status code

now checking with a regex with words of the form (...)/(...)

…iption parsing in operations

Update pathBuilder struct

…rations now the paths are checked with a prefix of the form $/ instead of $

…the case of a wrong http status code

now checking with a regex with words of the form (...)/(...)

…iption parsing in operations

…mplementation

dgutson · 2022-05-20T21:18:25Z

encoding/openapi/build.go

+	}
+
+	return ast.NewList(items...)
+	//pb.path.Set("security", ast.NewList(items...))


remove commented code

dgutson · 2022-05-20T21:25:22Z

encoding/openapi/pathResponse.go

+
+	}
+
+	//rb.mediaTypes.Set("description", description)


remove commented code

araddon · 2022-06-12T18:47:55Z

I started hacking against this pr and looking at original tickets and thought i would leave what i learned:

This does not cover the openapi[yaml,json] deserialize -> non-interpreted cue -> simplified cue decoding (which i was looking for) . both the 386, 735 tickets are relatively ambiguous if they cover that but mostly refer to the cue -> openapi[yaml,json] encoding .
As i was hacking the package namespacing became an issue, the encoding/jsonschema contains the bulk of the decode code now, but it appears the desire to separate the jsonschema vs openapi into two packages. Since none of the openapi specific decoding (paths, security, etc) is implemented I ran into either needing jsonschema/decode.go decoder, state objects to be public or the need to put the bulk of the openapi objects -> cue into jsonschema/decode.go, constraint.go . My rough thoughts were the bulk of the code in decoder, state relates to translating generic cue ast (from json/yaml deserialization) into simpler cue objects, and had little to do with either spec and thus need to share single package.

dgutson · 2022-09-06T21:31:56Z

I started hacking against this pr and looking at original tickets and thought i would leave what i learned:

This does not cover the openapi[yaml,json] deserialize -> non-interpreted cue -> simplified cue decoding (which i was looking for) . both the 386, 735 tickets are relatively ambiguous if they cover that but mostly refer to the cue -> openapi[yaml,json] encoding .

As i was hacking the package namespacing became an issue, the encoding/jsonschema contains the bulk of the decode code now, but it appears the desire to separate the jsonschema vs openapi into two packages. Since none of the openapi specific decoding (paths, security, etc) is implemented I ran into either needing jsonschema/decode.go decoder, state objects to be public or the need to put the bulk of the openapi objects -> cue into jsonschema/decode.go, constraint.go . My rough thoughts were the bulk of the code in decoder, state relates to translating generic cue ast (from json/yaml deserialization) into simpler cue objects, and had little to do with either spec and thus need to share single package.

@qequ pls address this

qequ · 2022-09-13T01:08:24Z

@araddon the only feature I worked on in this PR was the encoding cue -> openapi spec, specifically the paths parsing and encoding that was missing, I didn't plan to create the decoding stage from an openapi spec to cue, I think that's an enormous feature and, Since it's been a while I created this PR, I don't know if there's been any advances on that. @mvdan ?

dgutson · 2022-09-28T21:29:56Z

@araddon anything else we can help to get this in?
Could we please address openapi[yaml,json] deserialize -> non-interpreted cue -> simplified cue in another PR?
We can create an issue if necessary.

dgutson · 2022-12-01T18:17:03Z

ping? @araddon

qequ · 2022-12-01T18:22:59Z

ping @mvdan @rogpeppe

qequ added 30 commits April 19, 2022 15:11

Added paths functionality to compose encoding for openAPI

852369c

Added main functions to build paths struct

7da9a34

Updated description creation in path

496044e

Add parsing functionalities to path's operations objects

f5d5163

Add error handling for PathBuilder struct

dbb3bca

Update pathBuilder struct

Updated path parsing prefix & added parsing for content struct in ope…

e1ae134

…rations now the paths are checked with a prefix of the form $/ instead of $

Update tests for paths implementation

85a75c8

Added checking for empty content in responses

a9eb4a5

Add test for case of empty content in responses of paths

46cff34

Add tests for checking multiples responses in a path, and failing in …

99a1864

…the case of a wrong http status code

Update content parsing

4516632

now checking with a regex with words of the form (...)/(...)

Add security and description parsing to operation object parsing

ead9792

Correct unit tests according to changes in security parsing and descr…

38d5b69

…iption parsing in operations

Remove dead code & change Regexp Match String with Compile

bb0aa1f

Add unit tests for more cases of openapi paths

662e56b

Added paths functionality to compose encoding for openAPI

e396460

Added main functions to build paths struct

4b0fd26

Updated description creation in path

9230263

Add parsing functionalities to path's operations objects

a0dae2f

Add error handling for PathBuilder struct

25e9efb

Update pathBuilder struct

Updated path parsing prefix & added parsing for content struct in ope…

443bd82

…rations now the paths are checked with a prefix of the form $/ instead of $

Update tests for paths implementation

e006996

Added checking for empty content in responses

4ca6f8c

Add test for case of empty content in responses of paths

a512c92

Add tests for checking multiples responses in a path, and failing in …

87fba45

…the case of a wrong http status code

Update content parsing

a1de92c

now checking with a regex with words of the form (...)/(...)

Add security and description parsing to operation object parsing

dba1a8f

Correct unit tests according to changes in security parsing and descr…

d4a60d3

…iption parsing in operations

Remove dead code & change Regexp Match String with Compile

1851a2f

Add unit tests for more cases of openapi paths

1a8a276

Merge branch 'pathsImplementation' of github.com:qequ/cue into pathsI…

c64290d

…mplementation

qequ requested a review from cueckoo as a code owner May 20, 2022 21:10

dgutson reviewed May 20, 2022

View reviewed changes

Remove unnecesary comments

08b449f

myitcv added the Discuss Requires maintainer discussion label May 23, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

encoding/opeanpi: paths parsing for OpenAPI spec #1727

encoding/opeanpi: paths parsing for OpenAPI spec #1727

qequ commented May 20, 2022

dgutson May 20, 2022

dgutson May 20, 2022

araddon commented Jun 12, 2022 •

edited

dgutson commented Sep 6, 2022

qequ commented Sep 13, 2022

dgutson commented Sep 28, 2022

dgutson commented Dec 1, 2022

qequ commented Dec 1, 2022

encoding/opeanpi: paths parsing for OpenAPI spec #1727

Are you sure you want to change the base?

encoding/opeanpi: paths parsing for OpenAPI spec #1727

Conversation

qequ commented May 20, 2022

dgutson May 20, 2022

Choose a reason for hiding this comment

dgutson May 20, 2022

Choose a reason for hiding this comment

araddon commented Jun 12, 2022 • edited

dgutson commented Sep 6, 2022

qequ commented Sep 13, 2022

dgutson commented Sep 28, 2022

dgutson commented Dec 1, 2022

qequ commented Dec 1, 2022

araddon commented Jun 12, 2022 •

edited