archetypes icon indicating copy to clipboard operation
archetypes copied to clipboard

docs(api-specs): revisions

Open gregswindle opened this issue 7 years ago • 1 comments

:bulb: TIP: Select the "Preview" Tab to help read these instructions.

1. Issue type

Type the letter "x" in the "checkbox" the best describe this issue.

  • [x] Feature: I'm requesting an enhancement.
  • [x] Other: I want to discuss something else.

2. User story summary

Describe what you want to accomplish and in what role/capacity, and why it's important to you. EXAMPLE: As a Job Applicant, I want to submit my resume In order to be considered for a job opening.

As a product maintainer, I want to use GitHub as much as possible In order to avoid relying on specs on hosted servers.

3. Acceptance criteria

Replace the examples below with your own imperative, "true/false" statements for the behavior you expect to see, or the behavior that would be true if there were no errors (for defects).

  • [ ] 1. OpenAPI spec URLs point to GitHub raw YAML resources, e.g., https://raw.githubusercontent.com/commonality/archetypes/master/schemas/v1/quantities/quantities.yaml
  • [ ] 2. All links in the repo point to raw.githubusercontent.com (including Swagger Validation badges)
  • [ ] 3. All Archetype API and SDK Documentation resources reside in the /docs directory
  • [ ] 4. All documents in the /docs directory are published to commonality.github.io
  • [ ] 5. commonality.github.io resources leverage RunKit as much as possible.

gregswindle avatar Sep 05 '17 08:09 gregswindle

"Raw" OpenAPI specification URLs on GitHub

  1. Locale: https://raw.githubusercontent.com/commonality/archetypes/master/schemas/v1/locales/locales.yaml
  2. Money: https://raw.githubusercontent.com/commonality/archetypes/master/schemas/v1/money/money.yaml
  3. Party: https://raw.githubusercontent.com/commonality/archetypes/master/schemas/v1/parties/parties.yaml
  4. Quantity: https://raw.githubusercontent.com/commonality/archetypes/master/schemas/v1/quantities/quantities.yaml

gregswindle avatar Sep 05 '17 19:09 gregswindle