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

Align Policy JSON Schema & Examples with spec #693

Conversation

avatarneil
Copy link
Contributor

Explain pull request

This PR is to resolve #599, which highlighted inconsistencies between the spec and JSONSchema definitions & examples. The approach taken was to leave the spec as-is (for now) in order to be non-breaking, and to update the JSONSchema definitions & examples to align with the spec in its current state.

Is this a breaking change

  • No, not breaking

Impacted Spec

  • policy

Additional context

For MDS 2.0, we may want to explore structuring this in accordance with the JSONAPI spec, e.g.

{
  "data": {
    "type": "policies",
    "attributes": {
     }
  }
},

@avatarneil avatarneil requested a review from a team as a code owner September 8, 2021 16:50
@schnuerle schnuerle linked an issue Sep 9, 2021 that may be closed by this pull request
@schnuerle schnuerle added this to the 1.2.0 milestone Sep 9, 2021
@schnuerle schnuerle added the Policy Specific to the Policy API label Sep 9, 2021
@schnuerle
Copy link
Member

Per our working group meeting this update was agreed upon. We will merge to dev by the end of the week.

@schnuerle schnuerle merged commit 09261bb into openmobilityfoundation:dev Sep 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Policy Specific to the Policy API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Policy API] Response when returning a single object is not clear
2 participants