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 version 3.1.0 schema #42

Merged
merged 8 commits into from
Jul 20, 2016
Merged

Add version 3.1.0 schema #42

merged 8 commits into from
Jul 20, 2016

Conversation

jbarnicle
Copy link
Contributor

Addresses issues #25, #26

@jbarnicle jbarnicle changed the title add version 3.0.1 schema add version 3.1.0 schema Jul 19, 2016
@jbarnicle jbarnicle changed the title add version 3.1.0 schema W.I.P. add version 3.1.0 schema Jul 19, 2016
@afeld
Copy link
Member

afeld commented Jul 20, 2016

Looks good to me! @gregelin @joshuamckenty?

$ diff kwalify/component/v3.0.0.yaml kwalify/component/v3.1.0.yaml
75a76,78
>             desc: |
>               This field will be deprectated in future versions of the schema.
>               Please use control_origins.
76a80,83
>           control_origins:
>             type: seq
>             sequence:
>               - type: str
88a96,98
>             desc: |
>               This field will be deprectated in future versions of the schema.
>               Please use implementation_statuses.
94a105,113
>           implementation_statuses:
>             type: seq
>             sequence:
>               - type: str
>                 enum:
>                   - partial
>                   - complete
>                   - planned
>                   - none
$ diff examples/component_v3.0.0.yaml examples/component_v3.1.0.yaml
14,15c14,19
<   implementation_status: partial
<   control_origin: shared
---
>   implementation_statuses:
>     - partial
>     - planned
>   control_origins:
>     - shared
>     - inherited

- partial
- complete
- planned
- none
Copy link
Member

Choose a reason for hiding this comment

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

Maybe we add a comment or something saying this is deprecated, or at least that implementation_statuses is an alternative?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@pburkholder
Copy link
Contributor

I went to the Kwalify project to see if deprecated could be added, so the user could get something back like:

$ kwalify -f kwalify/component/v3.1.0.yaml examples/busted.yaml
examples/busted.yaml#0: WARNING
  - [/] key 'control_origin' is deprecated: "Use control_origins instead"

BUT -- kwalify is hosted in SourceForge, and I didn't have the gumption to try. Still, it would be cool if the kwalify file had something like:

          control_origin:
            type: str
            deprecated: true
            deprecation_message: "Use control_orgins instead"
          control_origins:
            type: seq
            sequence:
              - type: map
                mapping:
                  text:
                    type: str

Is it worth working on? Probably not.

@afeld
Copy link
Member

afeld commented Jul 20, 2016

At the very least, we can put something in the description. Kwalify hasn't been updated since 2013, so I'm not convinced it's worth putting a lot of time into...or that it's what we will stick with mid/long-term. I would raise the idea as a feature request, but probably not bother with implementation unless you hear back from the maintainer(s).

@jbarnicle jbarnicle changed the title W.I.P. add version 3.1.0 schema Add version 3.1.0 schema Jul 20, 2016
@jcscottiii
Copy link
Member

LGTM!

@afeld afeld merged commit 0cc1f58 into master Jul 20, 2016
@afeld afeld deleted the add_version_3.0.1 branch July 20, 2016 20:18
@jokajak jokajak mentioned this pull request Jul 12, 2018
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