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

tighten up media type params #142

Closed
18 tasks done
catkins-miso opened this issue Aug 19, 2024 · 1 comment · Fixed by #202
Closed
18 tasks done

tighten up media type params #142

catkins-miso opened this issue Aug 19, 2024 · 1 comment · Fixed by #202
Assignees
Labels
Spec Change Track specific spec changes ideas until they are complete. Should be placed into a milestone.

Comments

@catkins-miso
Copy link
Contributor

catkins-miso commented Aug 19, 2024

  • add examples and update media types in paths for limit-type on all slim formats
    • seasonal slim proposal
    • RT slim proposal
    • forecast slim proposal
    • forecast slim snapshot
    • RT slim snapshot
  • define canonical names for all limit-types in the spec description limit.yaml
  • add include-psr-header examples and update media types for all snapshot
    • forecast detailed
    • forecast normal
    • RT detailed
    • RT normal
    • seasonal detailed
  • add inputs-used examples and update media types for slim proposals and snapshots (see optional inputs for slim proposals and snapshots #197)
    • forecast slim proposal: add named example
    • forecast slim snapshot: add media type with an example
    • RT slim proposal: add named example
    • RT slim snapshot: add media type with an example
@catkins-miso catkins-miso added the Discussion Inquiries that we want to have a record of for future reference. Can turn into "Spec Change" issues. label Aug 19, 2024
@catkins-miso catkins-miso added Spec Change Track specific spec changes ideas until they are complete. Should be placed into a milestone. and removed Discussion Inquiries that we want to have a record of for future reference. Can turn into "Spec Change" issues. labels Oct 10, 2024
@catkins-miso
Copy link
Contributor Author

This would be more appropriate implemented as a media type parameter, I think, since it doesn't change the resource, just elides names from the particular representation. If you are good with that, @getorymckeag, I will change this issue to update each of the media types we've parameterized including this one.

application/vnd.trolie.forecast-limits-snapshot.v1+json; names-header=false:
  schema: ...
  example:
    $ref: '../../example-narratives/examples/forecast-limits-active-power-names-header-elided.json'

image

I believe that means added an entry like these with good examples for the limit-type parameter we added for slim proposals and snapshot as well as the inputs-used parameter. I also think this deserves its own article to address:

  • limit-type is not optional / missing behavior is unspecified
  • inputs-used is assumed to be false unless specified. This would be clear from the differences in the examples
  • names-header is assumed to be true unless specified.

@catkins-miso catkins-miso changed the title consider making names header optional in snapshots tighten up media type params Nov 1, 2024
@catkins-miso catkins-miso pinned this issue Nov 1, 2024
@catkins-miso catkins-miso linked a pull request Nov 1, 2024 that will close this issue
@catkins-miso catkins-miso unpinned this issue Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Spec Change Track specific spec changes ideas until they are complete. Should be placed into a milestone.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants