Skip to content

[Feature] OpenAPI 3.1#47

Merged
elliot-huffman merged 4 commits intomainfrom
OpenAPI-3.1
Oct 9, 2025
Merged

[Feature] OpenAPI 3.1#47
elliot-huffman merged 4 commits intomainfrom
OpenAPI-3.1

Conversation

@elliot-huffman
Copy link
Contributor

@elliot-huffman elliot-huffman commented Oct 9, 2025

Updated the following files:

  • spec/SHIELD.json
  • spec/Data-Gateway.json

For the following:

  • Rename example fields to examples.

For examples field inside each schema and each individual property in schema:

  • Wrap all existing example field values with array (Any[]).
  • Replace the array values with a single value value in the first item of the original array.

For examples field outside schema (e.g. MediaContentType objects in PathItem > Operation > Request ):

  • Use Map[string, Example] instead to conform OpenAPI specification version 3.1

  • Both files loaded in SwaggerEditor, showing no warnings or errors.

  • Example options should be available on each API's request, response and parameter section, with summary as option label and description showing as Example description content.

Please see here for the original PR:
#18

elliot-huffman and others added 4 commits August 13, 2025 15:41
Some of the examples have been converted.
OpenAPI version number bumped to 3.1.
Removed nullable flags.
All work done was from Ferry, not me.

Co-Authored-By: Ferry To <ferry@verdantsparks.io>
Copilot AI review requested due to automatic review settings October 9, 2025 04:15
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review any files in this pull request.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@elliot-huffman elliot-huffman merged commit 53fd163 into main Oct 9, 2025
6 checks passed
@elliot-huffman elliot-huffman deleted the OpenAPI-3.1 branch October 9, 2025 04:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants