Skip to content

TODO.md

Latest commit

 

History

History
63 lines (58 loc) · 3.06 KB

TODO.md

File metadata and controls

63 lines (58 loc) · 3.06 KB

Todo

These are the steps defined to reach 1.0. Assistance is very welcome.

  • Handle mutually exclusive fields
  • Refactor the various NodeFactory modules to be a less confusing hierachical structure. Consider having factories subclass instead of use mixin
  • Decouple Document class for the source file. Consider a source file class instead
  • Validate that a reference creates the type of node that is expected in a context
  • Allow opening of references from additional files
  • Allow opening of openapi documents by URL
  • Support references by URL
  • Consider option to limit open by URL/path behaviour
  • Support converting CommonMark to HTML
  • Reach parity with OpenAPI specification for validation
  • Consider a lenient mode for a document to only have to comply with type based validation
  • Improve test coverage
  • Publish documentation of the interface through the structure
  • Consider a resolved context class for representing context with a node that can handle scenarios where a node is represented by both a reference and resolved context
  • Create error classes for various scenarios
  • Associate/resolve operation id / operation references
  • Do something to model expressions
  • Improve the modelling of namespace
  • Set up nicer string representations of key classes to help them be debugged
  • Ensure Array and Map nodes return empty ones by default rather than nil
  • Make JSON pointer public access to be consistent accepting string, array or (potentially) a pointer class
  • Support creating a default Server object on servers property of OpenAPI Node
  • Support relative URLs being able to be relative the first server object see: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#relative-references-in-urls
  • Support validating a Server URL based on default values
  • Validate paths to check path parameters within them appear in paths see: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#fixed-fields-10

For OpenAPI 3.1

  • Conditional nodes
  • Support webhooks
  • No longer require responses field on an Operation node
  • Require OpenAPI node to have webhooks, paths or components
  • Support the switch to a fixed schema dialect
  • Support summary field on Info node
  • Create a maxi OpenAPI 3.1 integration test to collate all the known changes
  • jsonSchemaDialect should default to OAS one
  • Allow summary and description in Reference objects
  • Add identifier to License node, make mutually exclusive with URL
  • ServerVariable enum must not be empty
  • Add pathItems to components
  • Callbacks can now reference a PathItem - previously required them
  • Check out whether pathItem references match the rules for relative resolution
  • Parameter object can have space delimited or pipeDelimited styles
  • Discriminator object can be extended
  • mutualTLS as a security scheme
  • I think strictness of Security Requirement rules has changed