Skip to content
This repository has been archived by the owner on Jul 27, 2020. It is now read-only.

WIP Generated OpenAPI specification #328

Merged
merged 31 commits into from
May 22, 2019
Merged

WIP Generated OpenAPI specification #328

merged 31 commits into from
May 22, 2019

Conversation

gr2m
Copy link
Contributor

@gr2m gr2m commented Dec 29, 2018

This is a work-in-progress implementation for part two of #168: "Generate OpenAPI specification"

  • I removed all operations but "Get a single issue"
  • I inlined all parameters and response schemas
  • Information like path parameter description got lost because we don’t have these. We’d need to maintain a list ourselves.

The response schemas are also much simpler. I will wait to see if @kytrinyx can provide schemas that GitHub is using internally for their REST APIs.

Test with

node bin/octokit-rest-routes.js update https://developer.github.com/v3/issues/#{get-a-single-issue,list-issues,create-an-issue,edit-an-issue,lock-an-issue,unlock-an-issue} --cached

Todos

@todo
Copy link

todo bot commented Dec 29, 2018

find a better place to define parameter examples

// TODO: find a better place to define parameter examples
const PARAMETER_EXAMPLES = {
owner: 'octocat',
repo: 'hello-world',
number: 1
}


This comment was generated by todo based on a TODO: comment in 4803037 in #328. cc @octokit.

@gr2m gr2m mentioned this pull request Dec 29, 2018
33 tasks
@gr2m gr2m self-assigned this May 21, 2019
@gr2m gr2m force-pushed the openapi-generated branch from 4803037 to 409e99f Compare May 21, 2019 18:27
@gr2m gr2m added this to the OpenAPI specification milestone May 21, 2019
@gr2m gr2m merged commit f751ce3 into openapi May 22, 2019
@delete-merged-branch delete-merged-branch bot deleted the openapi-generated branch May 22, 2019 05:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant