Skip to content

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Sep 9, 2022

Description

openapi 3.1 documentation for the response object

Motivation and Context

Ref #1986

How Has This Been Tested?

local

fixture:

openapi: 3.1.0
info:
  title: deref
  version: 1.0.0
paths:
  /a:
    get:
      operationId: aget
      responses:
        '200':
          description: a pet to be returned
          content: 
            application/json:
              schema:
                $ref: '#/components/schemas/Pet'

Screenshots (if appropriate):

parent:
ls-pr-1996-sample-1

targetSpec:
ls-pr-1996-sample-2

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

Copy link
Contributor

@char0n char0n left a comment

Choose a reason for hiding this comment

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

LGTM. Nice work.

PS: are you using transform-spec-fragment.js script to format the markdown fragments? (I assume yes, but just confirming). Thanks

@tim-lai tim-lai merged commit 18cb4f0 into main Sep 12, 2022
@tim-lai tim-lai deleted the feat/oas31-docs-response branch September 12, 2022 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants