Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • PeerTube PeerTube
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Activity
  • Graph
  • Jobs
  • Commits
Collapse sidebar
  • FramasoftFramasoft
  • PeerTubePeerTube
  • PeerTubePeerTube
  • Merge requests
  • !29

Better openapi readmes

  • Review changes

  • Download
  • Patches
  • Plain diff
Merged Average Dude requested to merge LoveIsGrief/PeerTube:feature/better-openapi-readmes into develop Feb 16, 2020
  • Overview 3
  • Commits 7
  • Pipelines 5
  • Changes 7

As started in this discussion, @rigelk this MR adds the possibility to customize the READMEs generated by the openai-generator.

I modified the README.mustache for python (copied from github ). DefaultGenerator and each language's generator e.g PythonClientCodegen.java can be searched for additionalProperties.put which will contain more fields for the templates.

The MR is editable so you can edit the README as you like and see the results in https://framagit.org/peertube-test/apis/ e.g python has "THIS IS A CUSTOM README" at the beginning.

Edited Feb 18, 2020 by Rigel Kent
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: feature/better-openapi-readmes