#227 Better code completion proposal for name/key of additional properties #402

tfesenko · 2017-10-04T14:11:30Z

This PR provides better completion proposals and code templates for properties described as additionalProperties in OAS3 and Swagger v3

OAS3

Code assist

(<element> name) is proposed for elements described with additionalProperties in JSON Schema. When chosen, the new name is selected for editing.
In this screencast, code assist suggests (schema name) for a schema and then (property name) for a schema describing a property:

Similar approach applies to other components (callbacks, links, examples, etc) and other additionalProperties:

I am not attaching screenshots for all supported cases as I have provided tests for them.

Tests

OpenApi3ContentAssistProcessorTest provides tests for all major cases:

Schema
Schema Property
All other components (Links, Callbacks, Parameters, Examples, RequestBodies, Headers, SecuritySchemes)
Media types
Encodings
Server variables

Note that some elements still have strange names:

Discriminator#mappings: _type_
OauthFlow#Scopes: _type_
Parameter names in Links: (any name)

Current status is covered by tests.

Implementation

JsonProposalProvider creates proposal for the additionalProperties elements. The label is described by a new TypeDefinition#getLabel() which tried to get needed information from JSON Schema. For the schema property, we can't infer the needed name - property - from the schema, so I added a title property to JSON Schema.

JSON Schema

I had to add one line to the JSON Schema to provide a correct (property name) instead of (schema name)
To do it, I updated our JSON Schema generator. It's generated using commit 83638080c70784ca84fcfbf86af948c6e98bcbba on
https://github.com/RepreZen/gnostic/tree/task/KZOE-227

Code templates

Named schemas and properties now have code templates for major cases. These code templates are generated by Activator.addNamedSchemaTemplatesInSchemas() and addNamedSchemaTemplatesInSchemaProperties() using already existing code templates defined for inline schemas in templates.xml.
I also added code template for a schema ref for schema properties.

Tests

I added a new code-template context for schema properties to SchemaObject.yaml. It means that our JUnit tests verify that:

This context exists at a given location
All code templates provided for this context at this location will produce a valid OAS3 documentation.

Known issues

Restore Defaults on KaiZen>OpenAPI v3/Templates preferences page erases synthetic code templates generated for named schema and named property.

Implementation

I added a new context for named schema properties
Activator.addNamedSchemaTemplatesInSchemas() and addNamedSchemaTemplatesInSchemaProperties() build code templates dynamically
Usually we use template variable to define template parts that need to be selected. Variable names don't allow spaces or special characters, and we need it to be something like (schema name). So I added ElementNameResolver to handle it.

Swagger v2

Code assist

Similar code assist experience was implemented for Swagger v2:

I provided several tests for (schema name) and (property name) in SwaggerProposalProviderTest, but I did not test it as thorough as foer OAS 3.

Code templates

I did NOT provide synthetic code templates for named schemas in Swagger v2. Anyway, only one code template is available for a named schema,

JSON Schema

Again, JSON Schema was modified to provide a correct value for (property name), but as JSON Schema for Swagger v2 is not generated, there is no need to update the schema generator.

…es keywords

…omizations for the 'property'

…y the 'additionalProperties'

…so has a 'title'

…tes) caused by invalid tab width pref

… format '(schema name)' and select it for editing

…the _end_ of the inserted proposal

…r v2 + tests

Generated using commit 83638080c70784ca84fcfbf86af948c6e98bcbba on https://github.com/RepreZen/gnostic/tree/task/KZOE-227

tfesenko · 2017-10-04T18:09:19Z

@ghillairet , @tedepstein , this PR is ready for review.

…(mediaType name) value

tedepstein · 2017-10-04T21:06:53Z

Looks good, Tanya! I will plan to test it after it has passed code review and been merged.

ghillairet

Passed QA, all tests passed as well.

I just left a comment about a possible NPE.

Also I noted that there is a content assist proposal _key_ present in responses > content > schema. Not sure why it is there.

ghillairet · 2017-10-06T13:15:55Z

com.reprezen.swagedit.core/src/com/reprezen/swagedit/core/schema/ComplexTypeDefinition.java

+
+    @Override
+    public String getLabel() {
+        return Iterables.getFirst(complexTypes, null).getLabel();


You will get a NPE if complexTypes is null here.

Thanks! Addressed in 9f2cd7d

…_key_' proposal in code assist

tfesenko · 2017-10-06T14:33:45Z

@ghillairet , thanks for reporting a case with a _key_ proposal for an anonymous schema in media types. I can't reproduce it - I even created a test for it in 3a4675d.
Can you please double-check it and share the OAS3 file with me?

…perties Add test to show that _key_ is still present in content assist for response content schema.

ghillairet · 2017-10-06T16:07:19Z

@tfesenko See my commit that adds a test to show that key is still present for response content schema.

tfesenko · 2017-10-06T21:46:27Z

@ghillairet , I extracted #411 "_type_ as context assist proposal for context schema" which can be addressed later.
Merging this PR as it passed your code review and QA.

tfesenko added 20 commits September 26, 2017 12:11

#227 - use schema name for code-assist for additionalProperties

9b18047

#227 - code assist: select the schema name for the additionalProperti…

e839fab

…es keywords

Fix compilation errors in tests

e027674

#227 - generate named schema templates from inline schema templates

522b4b3

Merge branch 'master' into task/227

1bc87dc

#227 - clean up code for the 'additionalProperties' code assist, cust…

833d212

…omizations for the 'property'

Manually merge master into task/227

9194da2

Manually merge master into task/227

1a46dc0

#227 - use '(schema name)' as a proposal for the elements described b…

a3e7351

…y the 'additionalProperties'

#227 - fix reference type provider for cases when a reference node al…

6360421

…so has a 'title'

#227 - fix test failures in CodeTemplateTextTest (named schema templa…

fd8c537

…tes) caused by invalid tab width pref

#227 - add dynamic code templates for named schema properties + tests

2ee8900

#227 - code templates for named schemas should create schema names in…

7da4404

… format '(schema name)' and select it for editing

#227 - restore cursor position for empty selection - it should be at …

4e80a49

…the _end_ of the inserted proposal

#227 - tests for code assist for component keys

b6d8378

#227 - more tests for code assist for the additionalProperties elements

a62a95a

#227 - make getTabWidth() reusable

e43d350

#227 - remove unneeded JSON Schema customizations

3931b3c

#227 - Fix code assist proposal for named schema properties in Swagge…

648042a

…r v2 + tests

#227 - regenerate JSON Schema for OAS3

919d64d

Generated using commit 83638080c70784ca84fcfbf86af948c6e98bcbba on https://github.com/RepreZen/gnostic/tree/task/KZOE-227

tfesenko requested a review from ghillairet October 4, 2017 18:09

tfesenko assigned ghillairet Oct 4, 2017

tfesenko added 3 commits October 4, 2017 15:12

Merge branch 'master' into task/227

687efbe

Merge branch 'master' into task/227

3575040

#227 - fix tests for code-assist for media types - they don't need a …

6ca2f96

…(mediaType name) value

Merge branch 'master' into task/227

f2251a4

ghillairet approved these changes Oct 6, 2017

View reviewed changes

#227 - test that an anonymous schema in media types does not have a '…

3a4675d

…_key_' proposal in code assist

#227 - fix a potential NPE

9f2cd7d

[#227] Better code completion proposal for name/key of additional pro…

0baa0ab

…perties Add test to show that _key_ is still present in content assist for response content schema.

Merge branch 'master' into task/227

476b653

tfesenko mentioned this pull request Oct 6, 2017

_type_ as context assist proposal for context schema #411

Open

tfesenko merged commit fe90082 into master Oct 6, 2017

tfesenko deleted the task/227 branch October 6, 2017 21:46

tedepstein mentioned this pull request Oct 27, 2017

Query parameter template includes default type integer/format int64 #421

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#227 Better code completion proposal for name/key of additional properties #402

#227 Better code completion proposal for name/key of additional properties #402

tfesenko commented Oct 4, 2017 •

edited

Loading

tfesenko commented Oct 4, 2017

tedepstein commented Oct 4, 2017

ghillairet left a comment

ghillairet Oct 6, 2017

tfesenko Oct 6, 2017

tfesenko commented Oct 6, 2017

ghillairet commented Oct 6, 2017

tfesenko commented Oct 6, 2017

#227 Better code completion proposal for name/key of additional properties #402

#227 Better code completion proposal for name/key of additional properties #402

Conversation

tfesenko commented Oct 4, 2017 • edited Loading

OAS3

Code assist

Tests

Implementation

JSON Schema

Code templates

Tests

Known issues

Implementation

Swagger v2

Code assist

Code templates

JSON Schema

tfesenko commented Oct 4, 2017

tedepstein commented Oct 4, 2017

ghillairet left a comment

Choose a reason for hiding this comment

ghillairet Oct 6, 2017

Choose a reason for hiding this comment

tfesenko Oct 6, 2017

Choose a reason for hiding this comment

tfesenko commented Oct 6, 2017

ghillairet commented Oct 6, 2017

tfesenko commented Oct 6, 2017

tfesenko commented Oct 4, 2017 •

edited

Loading