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

Use a generic versioning header #455

Closed
Retzoh opened this issue Feb 26, 2020 · 4 comments
Closed

Use a generic versioning header #455

Retzoh opened this issue Feb 26, 2020 · 4 comments
Assignees
Labels
Agency Specific to the Agency API enhancement New feature or request Policy Specific to the Policy API Provider Specific to the Provider API
Milestone

Comments

@Retzoh
Copy link
Contributor

Retzoh commented Feb 26, 2020

Is your feature request related to a problem? Please describe.

In #444 we moved the versioning spec to one file, used by all the APIs.
To avoid breaking changes in the Provider API, the Accept-content header was kept as application/vnd.mds.provider+json.

Describe the solution you'd like

With the 0.5.0 milestone, we can remove the .provider part of the header since it is now available for all the APIs.

The header would become application/vnd.mds+json.

Is this a breaking change

A breaking change would require consumers or implementors of the API to modify their code for it to continue to function (ex: renaming of a required field or the change in data type of an existing field). A non-breaking change would allow existing code to continue to function (ex: addition of an optional field or the creation of a new optional endpoint).

  • Yes, breaking

Impacted Spec

For which spec is this feature being requested?

  • agency
  • policy
  • provider

Describe alternatives you've considered

Leave the header as it is.

Additional context

None

@thekaveman thekaveman added this to the Future milestone Feb 26, 2020
@sarob sarob added Agency Specific to the Agency API enhancement New feature or request Policy Specific to the Policy API Provider Specific to the Provider API labels Mar 8, 2020
@thekaveman thekaveman modified the milestones: Future, 1.0.0 Apr 9, 2020
@marie-x marie-x self-assigned this May 27, 2020
@marie-x
Copy link
Collaborator

marie-x commented May 27, 2020

Sounds good to me

@schnuerle
Copy link
Member

It looks like this change is now in dev, correct @Retzoh @karcass? Can we close this issue now?

@marie-x
Copy link
Collaborator

marie-x commented Jun 26, 2020

I believe so.

@thekaveman
Copy link
Collaborator

Yes it is in there.

Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agency Specific to the Agency API enhancement New feature or request Policy Specific to the Policy API Provider Specific to the Provider API
Projects
None yet
Development

No branches or pull requests

5 participants