-
Notifications
You must be signed in to change notification settings - Fork 9.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update JSON example files (#3244) #3254
Closed
Closed
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
Update TOB.md
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
…s of the spec (#2574) * workflows: update used actions * . * bikeshed rendering (WIP) * bikeshed; split into v2, v3 directories * bikeshed; fixes to TOC,code blocks and indent levels * bikeshed; work from unmodified .md files * bikeshed; .gitignore * bikeshed; separate header for v3.0.1 for now * respec; as an alternative to bikeshed * Rename bikeshed to md2html * md2html; current setup * md2html; wip * md2html; fix 1 toc bug * md2html; fix another toc bug * md2html; fix 1 respec toc bug * md2html; fix another bikeshed toc bug * respec; former editor support - needs ReSpec 20.x * Latest respec tweaks * pre block css background, RFC ref fixes * Github gist syntax highlighting css * md2html: move to scripts dir * md2html: resolve relative links for examples * md2html: use respec js from spec.openapis.org site * md2html: find gist.css regardless of run dir * md2html: don't mix https and http content (toc) * md2html; include google analytics * md2html; build putative versions 4,5 etc * md2html; tidying up * md2html; specify lang="en" in html * build: update deps * fix: style examples bugs, refs #2488 * fix: update highlightjs call in md2html * feat: add github action Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com> * build: create a `latest.html` ReSpec version Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
…re appropriate (#2586) * Fix typo in v3.1 schema tests * Remove v3.1 schema test for server variable JSON Schema can't express this constraint * v3.1 Schema fix. $ref should be a uri-reference
docs: add CodeTriage badge and CTA to README.md
Does this work? Just pointing out that there is a Subscribe to Calendar button. DIY.
…branches (#2597) Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
* fix: v2.0 maintainers and version/date Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com> * Add some largely non-visible SEO improvements to the rendered spec Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
* nuke proposal prefixes * Add YYYY-MM-DD prefixes to proposal documents Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
* fix: md2html/build.sh specify bash in shebang Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com> * fix: changes for abstract title in md2html.js Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
…mas) (#2614) * Add test cases for valid and invalid top-level schemaObject types Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com> * Update workflow actions to node 14 Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
Makes the workflow trigger match the comment, thus giving people more time to add agenda items
#2157: Update schema to validate refs in headers of encoding objects
Add accessible meetings slide to agenda template
This makes metaschema consistent with the 3.0.x spec. Refs #2666
* fix: typo spelling grammar * Update proposals/2019-07-17-Webhooks.md change ``request`` to ``requests`` Co-authored-by: Nate <37554478+servusdei2018@users.noreply.github.com> Co-authored-by: Nate <37554478+servusdei2018@users.noreply.github.com>
generated via: perl -MYAML::XS -MJSON::MaybeXS -we'$YAML::XS::Boolean="JSON::PP"; print Dump(JSON::MaybeXS->new->decode(do { local $/; <> }))' input.json > output.yaml
* minor simplification of v3.1 schema "if the X property is present, then apply this constraint to property X" can be simplified by simply stating the constraint for property X. * add missing constraint to "header" https://spec.openapis.org/oas/v3.1.0#headerObject * allowEmptyValue and allowReserved don't make sense for headers * collapse single-item "enum"s in "cookie" and "header" to "const"
If the wrong type is used for a particular piece of data, then a bare "required" will validate as true, causing the "if" clause to be true, which can lead to confusing errors when the "then" schema then fires, instead of the error occurring at a higher position in the schema.
https://spec.openapis.org/oas/v3.1.0#pathTemplating "The value for these path parameters MUST NOT contain any unescaped “generic syntax” characters described by [[!RFC3986]]: forward slashes (/), question marks (?), or hashes (#)."
the implementation of the OpenAPI v3.1 Spec in Go with generics
(port of PR #2127 to v3.1)
operationId in the link object is a string
Make PathItem operation properties specific.
Added Oxygen OpenAPI editor
See https://github.com/OAI/OpenAPI-Specification/blob/main/versions/1.2.md#523-operation-object. The maximum of 120 characters is a "SHOULD", which according to RFC 2119 is a mere recommendation.
Co-authored-by: webron <webron@users.noreply.github.com>
Update README.md
…minator" (#3137) "The discriminator object is legal only when using one of the composite keywords oneOf, anyOf, allOf." https://spec.openapis.org/oas/v3.1.0#discriminator-object
Remove analytics/tracking pixel from README.md (doesn't affect the spec, so merging directly to main)
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
Fix minor typo and add "that" for clarity and ease of understanding.
Co-authored-by: Darrel <darrmi@microsoft.com>
As discussed on last week's call
Could you rebase and/or force-push this PR so it does not contain unrelated changes? Thanks. |
handrews
added
the
examples
requests for more or better examples in the specification
label
Jan 29, 2024
No response to rebase request since May 2023, and I don't see any commits in this PR from the submitter so I can't tell what the intent was. I'm just going to close this. |
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.
#3244