API Flow v0.2 - Githubissues

JonathanMontane commented 7 years ago

NOT READY FOR REVIEW

This PR modifies API-Flow to support a lot more features (like multiple URLs on a single resource)

Model

[x] Split Core.js into Parameter.js, ParameterContainer.js, Response.js, and Api.js
[x] Split Utils.js into Contact.js, License.js and Info.js
[x] Split Auth.js into many auths/*.js files
[x] Rename the Context object into Api
[x] Rename the internals field of Parameter into constraints
[x] Rename the externals field of Parameter into applicableContexts
[x] Rename the Body object into Context
[x] Remove useless methods from Group (e.g. mergeWithGroup)
[x] Update getRequests to provide a RequestMap
[x] Add getRequestIds to Group
[x] Remove useless methods from Request
[x] Remove useless methods from ParameterContainer
[x] Completely refactor URL to use the (extractable) node lib url and URLComponents
[x] Create the URLComponent model
[x] Support multiple URLs on a single request (change url field into urls)
[x] Refactor references to separate the concept of relative reference from the content resolution.
- [x] create a single Reference model
- [x] create a JSONSchema model (in Constraint.js)
- [x] create an XMLSchema model (in Constraint.js)
- [x] remove Exotic references ?
- [x] remove LateResolution references
[x] create a Store to replace ReferenceContainer
[x] create a Variable to replace the use of JSONSchemaReference in ReferenceContainer to model environment variables
[x] decompose Request into Resource and Request to separate resources from methods.
[x] introduce the concept of Interface to help fingerprint shared semantics

Parsers

General

Add the static method isParsable to parsers with the following interface:

Parser.isParsable = ({ content, file, url }):boolean =>{ ... }

[x] swagger/v2
[ ] swagger/v3
[ ] raml/v0.8
[x] raml/v1
[ ] postman/v1
[ ] postman/v2
[ ] insomnia/v3
[ ] curl/v1
[ ] __internals__
[x] dummy

Add the method resolve to parsers with the following interface:

parser.resolve = ({ fsResolver, httpResolver }, updatedItems, item) => {
  ...
  return updatedItems
}

[ ] swagger/v2
[ ] swagger/v3
[ ] raml/v0.8
[ ] raml/v1
[ ] postman/v1
[ ] postman/v2
[ ] insomnia/v3
[ ] curl/v1
[x] dummy

Refactoring/Writing

[x] refactor swagger/v2
[ ] write swagger/v3
[ ] refactor raml/v0.8
[x] write raml/v1
[ ] refactor postman/v1
[ ] refactor postman/v2
[ ] refactor insomnia/v3
[ ] refactor curl/v1
[ ] refactor __internals__
[ ] refactor paw

Serializers

[x] refactor swagger/v2
[ ] write swagger/v3
[ ] refactor raml/v0.8
[x] write raml/v1
[ ] refactor postman/v1
[x] refactor postman/v2
[ ] refactor insomnia/v3
[ ] refactor curl/v1
[ ] refactor __internals__
[x] refactor paw

Documentation

Models

[x] document Api.js
[x] document Auth.js
[x] document Constraint.js
[x] document Contact.js
[x] document Context.js
[x] document Group.js
[x] document Item.js
[x] document Info.js
[x] document Interface.js
[x] document License.js
[x] document ModelInfo.js
[x] document Parameter.js
[x] document ParameterContainer.js
[x] document Reference.js
[x] document Request.js
[x] document Resource.js
[x] document Response.js
[x] document Store.js
[x] document URL.js
[x] document URLComponent.js
[x] document Variable.js

Parsers

[x] document swagger/v2
[ ] document swagger/v3
[ ] document raml/v0.8
[x] document raml/v1
[ ] document postman/v1
[ ] document postman/v2
[ ] document insomnia/v3
[ ] document curl/v1
[ ] document __internals__
[ ] document paw

Serializers

[x] document swagger/v2
[ ] document swagger/v3
[ ] document raml/v0.8
[x] document raml/v1
[ ] document postman/v1
[x] document postman/v2
[ ] document insomnia/v3
[ ] document curl/v1
[ ] document __internals__
[x] document paw

Dependencies

[x] update immutable dependencies to >= 3.8 to have flow types

Typing

[ ] add declaration files containing the types of each object in the models

Styling

[x] move to 2 spaces instead of 4
[x] increase line limit to 100
[x] force use of const where applicable
[x] force numbers to be written as strings when used as keys in an object: e.g. { 123: 321 } => { '123': 321 } (proven to reduce bugs with immutable)

Testing

[x] change the testing style to a more standard mocha style
[x] src/**/__tests__/*-test.js => src/**/__tests__/*.spec.js

Models

[x] write tests for models/Parameter.js
[x] write tests for models/ParameterContainer.js
[x] write tests for models/Request.js
[x] write tests for models/Response.js
[x] write tests for models/Api.js
[x] write tests for models/URL.js
[x] write tests for models/Constraint.js
[x] write tests for models/Auth.js
[x] write tests for models/Context.js
[x] write tests for models/Group.js
[x] write tests for models/Contact.js
[x] write tests for models/License.js
[x] write tests for models/Info.js
[x] write tests for models/ModelInfo.js
[x] write tests for models/URLComponent.js
[x] write tests for models/Interface.js
[x] write tests for models/Resource.js
[x] write tests for models/Store.js
[x] write tests for models/Reference.js
[x] write tests for models/Variable.js
[ ] write tests for models/Item.js

Parsers

[x] write tests for parsers/swagger/v2/Parser.js
[ ] write tests for parsers/swagger/v3/Parser.js
[ ] write tests for parsers/raml/v0.8/Parser.js
[x] write tests for parsers/raml/v1/Parser.js
[ ] write tests for parsers/postman/v1/Parser.js
[ ] write tests for parsers/postman/v2/Parser.js
[x] write tests for parsers/paw/v3/Parser.js
[ ] write tests for parsers/insomnia/v3/Parser.js
[ ] write tests for parsers/curl/v1/Parser.js
[ ] write tests for parsers/__internals__/v1/Parser.js

Serializers

[x] write tests for serializers/swagger/v2/Serializer.js
[ ] write tests for serializers/swagger/v3/Serializer.js
[ ] write tests for serializers/raml/v0.8/Serializer.js
[x] write tests for serializers/raml/v1/Serializer.js
[ ] write tests for serializers/postman/v1/Serializer.js
[ ] write tests for serializers/postman/v2/Serializer.js
[x] write tests for serializers/paw/v3/Serializer.js
[ ] write tests for serializers/insomnia/v3/Serializer.js
[ ] write tests for serializers/curl/v1/Serializer.js
[ ] write tests for serializers/__internals__/v1/Serializer.js

Integrations

[ ] write diff tests for swagger v2 => swagger v2
[ ] write diff tests for swagger v2 => swagger v3
[ ] write diff tests for swagger v2 => raml v0.8
[ ] write diff tests for swagger v2 => raml v1
[ ] write diff tests for swagger v2 => postman v1
[ ] write diff tests for swagger v2 => postman v2
[ ] write diff tests for swagger v2 => insomnia v3
[ ] write diff tests for swagger v2 => curl v1
[x] write diff tests for swagger v2 => __internals__
[ ] write diff tests for swagger v3 => swagger v2
[ ] write diff tests for swagger v3 => swagger v3
[ ] write diff tests for swagger v3 => raml v0.8
[ ] write diff tests for swagger v3 => raml v1
[ ] write diff tests for swagger v3 => postman v1
[ ] write diff tests for swagger v3 => postman v2
[ ] write diff tests for swagger v3 => insomnia v3
[ ] write diff tests for swagger v3 => curl v1
[ ] write diff tests for swagger v3 => __internals__
[ ] write diff tests for raml v0.8 => swagger v2
[ ] write diff tests for raml v0.8 => swagger v3
[ ] write diff tests for raml v0.8 => raml v0.8
[ ] write diff tests for raml v0.8 => raml v1
[ ] write diff tests for raml v0.8 => postman v1
[ ] write diff tests for raml v0.8 => postman v2
[ ] write diff tests for raml v0.8 => insomnia v3
[ ] write diff tests for raml v0.8 => curl v1
[ ] write diff tests for raml v0.8 => __internals__
[ ] write diff tests for raml v1 => swagger v2
[ ] write diff tests for raml v1 => swagger v3
[ ] write diff tests for raml v1 => raml v0.8
[ ] write diff tests for raml v1 => raml v1
[ ] write diff tests for raml v1 => postman v1
[ ] write diff tests for raml v1 => postman v2
[ ] write diff tests for raml v1 => insomnia v3
[ ] write diff tests for raml v1 => curl v1
[x] write diff tests for raml v1 => __internals__
[ ] write diff tests for postman v1 => swagger v2
[ ] write diff tests for postman v1 => swagger v3
[ ] write diff tests for postman v1 => raml v0.8
[ ] write diff tests for postman v1 => raml v1
[ ] write diff tests for postman v1 => postman v1
[ ] write diff tests for postman v1 => postman v2
[ ] write diff tests for postman v1 => insomnia v3
[ ] write diff tests for postman v1 => curl v1
[ ] write diff tests for postman v1 => __internals__
[ ] write diff tests for postman v2 => swagger v2
[ ] write diff tests for postman v2 => swagger v3
[ ] write diff tests for postman v2 => raml v0.8
[ ] write diff tests for postman v2 => raml v1
[ ] write diff tests for postman v2 => postman v1
[ ] write diff tests for postman v2 => postman v2
[ ] write diff tests for postman v2 => insomnia v3
[ ] write diff tests for postman v2 => curl v1
[ ] write diff tests for postman v2 => __internals__
[ ] write diff tests for insomnia v3 => swagger v2
[ ] write diff tests for insomnia v3 => swagger v3
[ ] write diff tests for insomnia v3 => raml v0.8
[ ] write diff tests for insomnia v3 => raml v1
[ ] write diff tests for insomnia v3 => postman v1
[ ] write diff tests for insomnia v3 => postman v2
[ ] write diff tests for insomnia v3 => insomnia v3
[ ] write diff tests for insomnia v3 => curl v1
[ ] write diff tests for insomnia v3 => __internals__
[ ] write diff tests for curl v1 => swagger v2
[ ] write diff tests for curl v1 => swagger v3
[ ] write diff tests for curl v1 => raml v0.8
[ ] write diff tests for curl v1 => raml v1
[ ] write diff tests for curl v1 => postman v1
[ ] write diff tests for curl v1 => postman v2
[ ] write diff tests for curl v1 => insomnia v3
[ ] write diff tests for curl v1 => curl v1
[ ] write diff tests for curl v1 => __internals__
[x] write diff tests for __internals__ => swagger v2
[ ] write diff tests for __internals__ => swagger v3
[ ] write diff tests for __internals__ => raml v0.8
[ ] write diff tests for __internals__ => raml v1
[ ] write diff tests for __internals__ => postman v1
[x] write diff tests for __internals__ => postman v2
[ ] write diff tests for __internals__ => insomnia v3
[ ] write diff tests for __internals__ => curl v1
[x] write diff tests for __internals__ => __internals__

JonathanMontane commented 7 years ago

Working on e2e caused these fixes to be made:

RAML 1.0 Parser

[x] Base Endpoint is not saved in Store [bug]
[x] Do not use overlay in Request endpoint reference if no changes [bug]
[x] Add uuid to params [spec]
[x] Should key and name be the content-type in body params ? (probably not)
[x] Missing applicable contexts for body params
[x] Protocols are missing a “:”
[x] Support queryString
[x] Support libraries
[x] Support traits interfaces
[x] Do not infer type string on references
[x] Ignore protocols if they are the same as baseUri protocols
[ ] Fix protocol templating detection in models/URL.js
[x] Propagate is() values from resource to method (expand solved the issue)
[x] Last segment of sequence should not be named (right now is pathname)
[x] displayName should not be completeRelativeUri
[ ] support format in datatypes
[ ] support example in datatypes
[ ] support facets in dataTypes
[ ] fix enum with integer value being written as string values
[ ] support annotationTypes

Swagger 2.0 Parser

[x] Make use of underlay to store security at the api levels [feature]
[x] fix bug with schemes
[x] apply PathParams to path
[ ] support annotationTypes
[x] fix no context saved for x-www-urlencoded

Swagger 2.0 Serializer

[x] Check for underlays (probably not needed since the expand addition to raml1)
[x] Check for overlays ! (It seems that there are very little places where overlays are relevant in swagger v2 — only saw oauth2 and local schemes)
[x] HeaderParameter that are References should be resolved from Store [ spec :( ]
[x] Remove produces and consumes headers from shared params
[x] Fix bug with body params that have a reference
[x] Fix bug with type string for references
[x] Remove empty description fields
[x] add missing required field
[x] add produces (same with consumes) field if relevant
[ ] support format/collectionFormat field ?
[x] add missing name for body params
[x] missing oauth1 ? (normal => [spec does not support it]
[x] fix object type for parameters
[x] fix global tags object
[x] do not ignore with null auths [spec => can’t be null ]
[x] do not ignore path parameters from the resource object
[ ] support annotationTypes

RAML 1.0 Serializer

[x] Check for underlays
[x] Remove Version from baseUriParameters
[x] Check if we can improve multiline string dump [it uses folded string]
[x] fix parameters traits
[x] add resourceTypes
[x] add signatures to oauth1
[x] oauth2 authorizationGrants should be a list
[ ] missing global secured by
[x] fix body params ‘null’
[x] can response codes be strings ? [yes]
[x] missing null auth
[x] add is field to methods
[x] add #%RAML 1.0
[x] ignore mediaType trait
[x] missing required: false fields
[ ] support annotationTypes
[x] add scopes to oauth2 ?
[x] add scopes for oauth2 securedBy
[x] fix missing body params in request
[x] fix missing body params in response
[x] deal with parameter reference in responses [ impossible to have with the currently supported specs ]
[x] fix missing uriParameters

JonathanMontane commented 7 years ago

Swagger Parser 2

[x] Tags are saved as shared interfaces in the store

RAML Serializer 1

[x] RAML response codes strings are converted in integers after serialization into yaml format
[x] Fixed traits not being included if they don't have a corresponding underlay.

JonathanMontane commented 7 years ago

merged into #develop in #112. closing.

luckymarmot / API-Flow

API Flow v0.2 #110

NOT READY FOR REVIEW

Model

Parsers

General

Refactoring/Writing

Serializers

Documentation

Models

Parsers

Serializers

Dependencies

Typing

Styling

Testing

Models

Parsers

Serializers

Integrations

RAML 1.0 Parser

Swagger 2.0 Parser

Swagger 2.0 Serializer

RAML 1.0 Serializer

Swagger Parser 2

RAML Serializer 1