SLA4OAI-ResearchSpecification icon indicating copy to clipboard operation
SLA4OAI-ResearchSpecification copied to clipboard

Potential items for review

Open MikeRalphson opened this issue 5 years ago • 5 comments

  • [x] Make document instances identifiable and versionable, e.g. with a top-level sla4api property containing a semver value (I note that some of the examples have an sla property with a numeric 1.0 value)
  • [x] move Specification.md to something like versions/1.0.0-pre.md
  • [x] use full text of Apache-2.0 license so GitHub identifies it correctly
  • [x] GitHub: fix No description, website, or topics provided.
  • [ ] GitHub: add Code of Conduct and issue templates early in the process
  • [ ] use open formats for documentation directory
  • [ ] define a media-type for SLA instance documents following the vnd.oai. style with +json variant and version property
  • [ ] recommend naming of the instance documents (e.g. sla.yaml or sla.json)
  • [ ] consider registering an RFC5785 .well_known location
  • [ ] include a (cut-down?) contact object so contact information specific to the SLA info is available
  • [ ] allow specification extensions (x- properties) within SLA instance documents for extensibility
  • [x] update Swagger 2.0 examples to OpenAPI 3.x - should include patch version: e.g. 3.0.3
  • [ ] is it appropriate to use floating point number types for currency values (especially for things like BTC)? Suggest integer with divisor or multiplier / units modifier
  • [ ] use ISO-8601 for durations
  • [ ] set up CI to validate/lint markdown using mdv - no issues currently
  • [x] s/quartely/quarterly/g
  • [x] s/matric/metric/g
  • [x] s/managment/management/g

MikeRalphson avatar Nov 07 '18 19:11 MikeRalphson