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

add versioning for Agency and Policy API #444

Merged
merged 8 commits into from
Feb 26, 2020
Merged

add versioning for Agency and Policy API #444

merged 8 commits into from
Feb 26, 2020

Conversation

Retzoh
Copy link
Contributor

@Retzoh Retzoh commented Feb 6, 2020

Explain pull request

This is a pull request attempting to solve #422 without introducing any breaking changes to the provider API.

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).

  • No, not breaking

Impacted Spec

Which spec(s) will this pull request impact?

  • agency: adding versioning section
  • policy: adding versioning section
  • provider: moving the versioning section

Additional context

None

A minimal set of changes to add versioning to the Agency API and stay consistent with the Provider API.
@Retzoh Retzoh requested a review from a team February 6, 2020 17:20
@Retzoh Retzoh requested a review from a team as a code owner February 6, 2020 17:20
@claassistantio
Copy link

claassistantio commented Feb 6, 2020

CLA assistant check
All committers have signed the CLA.

agency/README.md Outdated Show resolved Hide resolved
agency/README.md Outdated Show resolved Hide resolved
@thekaveman thekaveman added Agency Specific to the Agency API documentation documentation change can be for code and/or markdown pages labels Feb 6, 2020
@Retzoh
Copy link
Contributor Author

Retzoh commented Feb 18, 2020

@thekaveman @jrheard I have updated the PR to move the provider Versioning section to a separate general-information file and link it from the other APIs. Let me know what you think.

@Retzoh Retzoh changed the title add versioning for Agency API add versioning for Agency and Policy API Feb 18, 2020
jrheard
jrheard previously approved these changes Feb 18, 2020
Copy link
Contributor

@jrheard jrheard left a comment

Choose a reason for hiding this comment

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

looks good to me! thanks for doing this!

general-information.md Outdated Show resolved Hide resolved
@thekaveman thekaveman added the Provider Specific to the Provider API label Feb 18, 2020
Copy link
Collaborator

@thekaveman thekaveman left a comment

Choose a reason for hiding this comment

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

LGTM from the Provider side

@Retzoh
Copy link
Contributor Author

Retzoh commented Feb 26, 2020

@thekaveman this has been validated on the Agency side too. Can you merge it ?

@marie-x
Copy link
Collaborator

marie-x commented Feb 26, 2020

LGTM from the Agency/Policy side

@thekaveman thekaveman added this to the 0.4.1 milestone Mar 1, 2020
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 documentation documentation change can be for code and/or markdown pages Provider Specific to the Provider API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants