korbiniankuhn/raml2html-material-theme

raml2html-material-theme's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Verify the validicy of the raml example

I have copied the code from your example and have pasted it to the api designer.

I see a lot of warnings(see the attached image). Maybe better to fix them.

Optionally add cURL commands ?

I really like your theme, IMHO the biggest missing feature is the cURL commands.

If possible, add warnings to command version

raml2html --theme raml2html-material-theme -i test.raml -o test.html

One time I run the code from the above and I have not seen any errors or warnings, but the html page is not rendering well. I have copied the source from your example folder: https://github.com/KorbinianKuhn/raml2html-material-theme/edit/master/example/api.raml , check with it and discovered that all should be working. So I have recreated my code on the https://www.mulesoft.com/platform/api/api-designer , copy-paste, recompile and all start working.

I don't know what was wrong, maybe the problem was that I have used the 'tab' instead of spaces, in that case it would be usefull to see some warn "You are using tab, use spaces instead".

For now I don't edit the raml in notepad, just copy-paste from https://www.mulesoft.com/platform/api/api-designer . And usually all works well.

v2: Todos

• Display Item Enum
• General API Information Panel
• Group Routes on first URL Segment
• General API Information - Security Schemes
• Travis CI
• Check styling for multiple examples on item property

Display issues

The modal doesn't appear to be painting correctly. It looks like the tabs aren't showing up.

Here's the raml I'm using:

#%RAML 1.0
title: Kraken API
version: v1
mediaType: application/json
baseUri: https://localhost/kraken-api/{version}
documentation:
- title: Home
  content: |
    This is the API guide for the kraken-api's RESTful API.
- title: Contact
  content: |
    Please contact [email protected] for any questions relating to this API.
securitySchemes: 
  custom_scheme:
    description: |
      X-header based authentication
    type: x-custom
    describedBy: 
      headers:
        X-Kraken-Token:
          description:
              Used to send a Kraken API token
          type: string
      responses:
        403:
          description: Forbidden
/health:
  description: Returns the health of kraken-api
  displayName: Health
  get:
    responses:
      200:
        body: Health
      424:
        body: Health
/environment/{id}:
  description: Get the environment by ID
  displayName: Get Environment
  securedBy: custom_scheme
  get:
    responses:
      200:
        description: The environment requested
        body: Environment
/createDeployment:
  description: Records a new deployment to be used later
  displayName: Create Deployment
  securedBy: custom_scheme
  post:
    body: CreateDeploymentRequest
    responses:
      201:
        description: Created
        body: Deployment
      400:
        description: Bad Request
        body:
          application/json:
            type: string
            example: "failed to parse request"
      500:
        description: Internal Server Error
/standup:
  description: Stands up a new kraken box
  displayName: Stand Up
  securedBy: custom_scheme
  post:
    body: StandupRequest
    responses: 
      102:
        description: Processing
/start/{awsID}:
    description: Starts a stopped Kraken box
    displayName: Start
    securedBy: custom_scheme
    put:
      responses: 
        204:
          description: No Content
        400:
          description: |
            Bad Request
            Only happens if awsID isn't supplied
/stop/{awsID}:
    description: Stops a stopped Kraken box
    displayName: Stop
    securedBy: custom_scheme
    put:
      responses: 
        204:
          description: No Content
        400:
          description: |
            Bad Request
            Only happens if awsID isn't supplied
/reboot/{awsID}:
    description: Reboots a stopped Kraken box
    displayName: Reboot
    securedBy: custom_scheme
    put:
      responses: 
        204:
          description: No Content
        400:
          description: |
            Bad Request
            Only happens if awsID isn't supplied
/terminate/{awsID}:
    description: Terminates a stopped Kraken box
    displayName: Terminate
    securedBy: custom_scheme
    delete:
      responses: 
        204:
          description: No Content
        400:
          description: |
            Bad Request
            Only happens if awsID isn't supplied
types: 
  UUID:
    type: string
    description: V4 UUID
    example: f2058d29-ae06-4f92-b028-18d9cfa2d8fb
    pattern: "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89aAbB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}"
  StandupRequest:
    description: Payload to request a new kraken box
    type: object
    properties:
      deploymentID: integer
      env: string
      user?: string
      userID: UUID
      teamBox: boolean
  CreateDeploymentRequest:
    description: Payload to create a new kraken deployment
    type: object
    properties:
      nickname: string
      userID: UUID
      userEmail?: string
      devComposeBranch: string
      standup: boolean
      useKrakenLogs: boolean
      applications?: Application[]
  Application:
    description: Information about an application
    type: object
    properties:
      yamlNames: string[]
      images: string[]
      branch: string
  Deployment:
    description: Recorded information from the deployment table
    type: object
    properties:
      id: integer
      createdDT: string
      updatedDT: string
      userID: string
      nickname: string
      active: boolean
      updatedBy: string
      devComposeBranch: string
      standup: boolean
      krakenLogsEnabled: boolean
  Environment:
    description: Recorded information from the environment table
    type: object
    properties:
      id: integer
      deploymentID: integer
      key: string
      status: string
      expire: string
      createdDT: datetime
      userID: string
      state: string
      updatedDT: datetime
      updatedBy: string
      previousState: string
      awsID: string
      teamBox: boolean
      currentStep: string
      previousSteps: string[]
  Health:
    description: The health object of the system
    type: object
    properties:
      db: DBHealthReport
  DBHealthReport:
    description: Health report of the db
    type: object
    properties:
      passing: boolean
      errors: object[]

Render the response's examples the similar to parameters examples

I have tested with examples for responses and see the next result:

I like how it done in the body's params section

Is it possible to make 'Examples' word bold(as header of the examples section), and wrap the response's examples into accordion, as in the body's params section?