Skip to content

Update dab.draft.schema.json#1782

Merged
Aniruddh25 merged 8 commits intomainfrom
abhishekkumams-patch-3
Oct 21, 2023
Merged

Update dab.draft.schema.json#1782
Aniruddh25 merged 8 commits intomainfrom
abhishekkumams-patch-3

Conversation

@abhishekkumams
Copy link
Copy Markdown
Contributor

Why make this change?

  • Currently our config and schema file had some differences, which is why even the config we support was showing to contain errors.

What is this change?

  • updating schema to reflect the correct supported config file.

How was this tested?

Screenshots

Before

image

After

image

@seantleonard
Copy link
Copy Markdown
Contributor

on the topic of fixing json schema validation, should this PR address #1793? Can our schema.json file validate that no extraneous fields are provided?

Copy link
Copy Markdown
Contributor

@seantleonard seantleonard left a comment

Choose a reason for hiding this comment

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

as a pre-req to merging this, please open a PR updating the public documentation's description of GraphQL and REST settings for an entity. There is no reference to "enabled" property and there is also still reference to allowing the config:

rest: "true",
graphql: "true"

this section also seems to be inaccurate:
https://learn.microsoft.com/en-us/azure/data-api-builder/configuration-file#graphql-operation

{
    "graphql": "true",
    "operation": "query"
  }

Comment thread schemas/dab.draft.schema.json Outdated
Copy link
Copy Markdown
Collaborator

@Aniruddh25 Aniruddh25 left a comment

Choose a reason for hiding this comment

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

Thanks for catching this!

@abhishekkumams
Copy link
Copy Markdown
Contributor Author

as a pre-req to merging this, please open a PR updating the public documentation's description of GraphQL and REST settings for an entity. There is no reference to "enabled" property and there is also still reference to allowing the config:

rest: "true",
graphql: "true"

this section also seems to be inaccurate: https://learn.microsoft.com/en-us/azure/data-api-builder/configuration-file#graphql-operation

{
    "graphql": "true",
    "operation": "query"
  }

Created a PR for the above in docs

@Aniruddh25 Aniruddh25 enabled auto-merge (squash) October 21, 2023 00:25
Copy link
Copy Markdown
Contributor

@aaronburtle aaronburtle left a comment

Choose a reason for hiding this comment

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

LGTM!

@Aniruddh25 Aniruddh25 dismissed seantleonard’s stale review October 21, 2023 01:08

Addressed the comments

@Aniruddh25 Aniruddh25 merged commit 7efa7f4 into main Oct 21, 2023
@Aniruddh25 Aniruddh25 deleted the abhishekkumams-patch-3 branch October 21, 2023 01:09
seantleonard pushed a commit that referenced this pull request Oct 21, 2023
## Why make this change?

- Currently our config and schema file had some differences, which is
why even the config we support was showing to contain errors.

## What is this change?
- updating schema to reflect the correct supported config file.

## How was this tested?

- Online Tool: https://www.jsonschemavalidator.net/

## Screenshots

### Before

![image](https://github.com/Azure/data-api-builder/assets/102276754/77664442-ba43-4e75-ad79-728a51686b10)


### After

![image](https://github.com/Azure/data-api-builder/assets/102276754/ff1c2873-fddc-4340-ac06-7aa90ac636cc)

---------

Co-authored-by: Aniruddh Munde <[email protected]>
seantleonard added a commit that referenced this pull request Oct 23, 2023
Cherry pick #1782  to 0.9 branch.


## Why make this change?

- Currently our config and schema file had some differences, which is
why even the config we support was showing to contain errors.

## What is this change?
- updating schema to reflect the correct supported config file.

## How was this tested?

- Online Tool: https://www.jsonschemavalidator.net/

## Screenshots

### Before


![image](https://github.com/Azure/data-api-builder/assets/102276754/77664442-ba43-4e75-ad79-728a51686b10)


### After


![image](https://github.com/Azure/data-api-builder/assets/102276754/ff1c2873-fddc-4340-ac06-7aa90ac636cc)

---------

## Why make this change?

- Reference associated issue using `#` syntax. e.g. Closes #XX
- Include summary (1-2 sentences) of linked issue to avoid redirecting
reviewers to different pages.
- Include links to any additional discussion threads related to this
change.

## What is this change?

- Summary of how your changes work to give reviewers context of your
intent.
  - Links to relevant documentation / StackOverflow, if applicable.

## How was this tested?

- [ ] Integration Tests
- [ ] Unit Tests

## Sample Request(s)

- Example REST and/or GraphQL request to demonstrate modifications
- Example of CLI usage to demonstrate modifications

Co-authored-by: Abhishek  Kumar <[email protected]>
Co-authored-by: Aniruddh Munde <[email protected]>
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.

4 participants