v3 updates docs to correctly describe shemas + schema.validate input + output types #200
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ut get_additional_property_
types
spacether
changed the title
spacether
force-pushed
the
v3_updates_request_body_and_other_docs
branch
from
bfc81b8
to
0cd16f3
Compare
spacether
added a commit
that referenced
this pull request
Aug 16, 2023
…+ output types (#200) * Removes incorrect lingering suffixes on format functions * Adds object input and ouput types in schema docs * Adds anchor to XDictInput in schema type * Adds output type anchor * Adds separate object input and output types * Adds invalid identifier note * Adds schemas.Unset accessed type object optional properties output type * Adds optional unset input type * Adds unset return value for object additional property, adds note about get_additional_property_ * Writes items input and output types * Adds Array model input type * Adds array output type * Changes Type Info to vaidate method * Creates and uses md io template * Adds index field to array schema docs * Adds new and from_dict_ methods to docs * Adds properties section * Fixes getitem documentation * Moves from_dict_ method later and adds self input * Adds base class info to object output class * Adds inputt type for object input class * Adds array input type * Adds array output type * Fixes addprops types * Puts object output types in code blocks * Adds object input and output type for anyType validate input * For anyType output types, lists object and array output class links * Fixes from_dict_ input and output types for anytype * Changes array input type to use io template * Removes properties from identiferPieces * Adds shared array and object output type templates * Uses output types for object properties * Adds unset to io template * Adds new and get_item docs for array output type * Writes doc for each header schema * Writes content schema docs * Writes parameter schemas * Writes doc for response header object schema * Removes collection schema doc files for header/query/path/cookie params * Updates schema ref info presentation * Uses io template for object input docs * Adds docRoot to to all payloads passed in to handlebars that render schema_docs with a partial * Adds docRoot passing to all locations that produce schema_doc * Removes inline schema locations * Fixes ref types for object input values * Adds module prefix to refed type if it is object or array * Adds missing docRoot * Labels schema types * Moves templates into types folder * Further type refactoring * Adds more refactoring * Removes helper prefixes from two templates * Moves schema_io_type templates * Moves more templates into types folder * Moves 3 files into types * Renames template because it is only used by schema doc * Moves the last type template into the types folder * Merges two templates * Removes redundant template * Consolidates validate method templates * Consolidates schema_cls templates * More schema template renaming * Moves another template into schema_cls * Reorganizes schema templates * Fixes composed schema anchors in schema docs * Adds refModule to schema class name for composed schemas in docs * Uses schemadoc templates for composed schema docs, removes descr and notes * Removes usages of complexTypePrefix * Removes setting complexTypePrefix in java payloads * Adds string enum literal to io and output types in docs * Adds int literals to schema docs * Adds bool literal * Uses typing instead of typing_extensions because python v3.8 is used * Updates ArrayInput items description * Fixes docRoot values * Fixes detection of self references in schema docs for output types * Fixes io detection of elf references * Removes unused imports * Adds inline schema types ot operation docs * Adds ref request body schema types * Lists all possible content-types in operations * Adds query params description using schema doc * Updates header parameters * Updates allowed content type listing * Adds path parameter docs using schema docs * Updates cookie param docs * Changes response_cls name to ApiResponse * Fixes response docs * FIxes build errors and java errors * Samples regen
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
v3 updates docs to correctly describe shemas + schema.validate input + output types
PR checklist
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/python*.For Windows users, please run the script in Git BASH.