Skip to content
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

support for writeOnly schema property #524

Closed
equalspeterd opened this issue Aug 14, 2019 · 2 comments
Closed

support for writeOnly schema property #524

equalspeterd opened this issue Aug 14, 2019 · 2 comments

Comments

@equalspeterd
Copy link

User story.
As a schema designer, I want to use the openAPI writeOnly property to control schema request/response behavior.

Describe the solution you'd like
support:

schemas:
    secretType:
          properties:
            x:
              type: string
              description: present/allowed in read and write operations (GET, POST, PUT)
            y:
              writeOnly: true
              description: allowed for PUT/POST, not included in GET responses (for example)
@philsturgeon
Copy link
Contributor

philsturgeon commented Aug 16, 2019

Great idea! We are using openapi-sampler here so we can invoke the skipWriteOnly: true option.

We'll need to work with JSON Schema Faker to get their support up to draft 7. json-schema-faker/json-schema-faker#289

@XVincentX
Copy link
Contributor

Superseded by #1142

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants