Code Monkey home page Code Monkey logo

raml-definition-system's Introduction

RAML.org Website

This repository contains the source code for the raml.org website written in Jekyll

Requirements

Running locally

Pull the code locally:

$ git clone [email protected]:raml-org/raml-org.git

Enter directory:

$ cd raml-org

Install all dependencies:

$ bundle install

Build & run the site:

$ bundle exec jekyll serve

How to add projects to the projects page?

RAML.org includes a projects page that lists tools around RAML that either are community or commercial driven. If you think, your project should be in this list, please fork this repository, add it into the projects.yml file, and send us a PR. We will review and let you know if we will be able to list it.

Another way to make sure your project is linked to our projects page is through assigning topics to your Github project. Links to each topics are below the list of projects on the projects page. The following topics are available:

Topic Description
raml-design Includes projects that specifically support people with the design of RAML documents.
raml-document Includes projects that focus on the documentation of APIs using RAML documents.
raml-build Includes projects that focus on build client or server code based on RAML documents.
raml-parser Includes projects that parses/validates RAML documents.
raml-test Includes projects that support people testing APIs based on RAML documents.
raml-utilities Includes other projects that do not fall into the other topics like converters.

Topics need to be assigned and managed by the owner of a project. Additionally, we still recommend people to search on Github for more projects that might not have these topics assigned.

Contribution

RAML's website is in fact an open source project and your contribution is very much appreciated. Before you start, you should check for open issues or open a fresh issue to start a discussion around an idea that you'd like to see on our website or a bug. If you want to support us fixing issues, please follow the steps below:

  1. Fork the repository on Github and make your changes on the develop branch (or branch off of it).
  2. Run the website to see if you fixed the issue.
  3. Send a pull request (with the develop branch as the target).

We will review your PR, comment if necessary, and merge it into our staging branch stg.

You can contribute to the following:

  • spelling mistakes
  • new projects
  • blog posts
  • and others, after carefully reviewing the issue you created

raml-definition-system's People

Contributors

ddenisenko avatar dreamflyer avatar greenkeeper[bot] avatar konstantinsviridov avatar petrochenko-pavel-a avatar postatum avatar sichvoge avatar svc-scm avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

raml-definition-system's Issues

An in-range update of @types/underscore is breaking the build 🚨

The devDependency @types/underscore was updated from 1.9.3 to 1.9.4.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/underscore is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Clean up package.json

There are a lot information that are currently not reflecting that repository. We need to clean that up.

Remove system types

I am not fully sure about the usefulness of the system types. I understand why they have been created in the first place, but its different know. Could we remove them and, for example, use simple native types for baseUri; something like: baseUri? : string. That will also avoid any boilerplate code in any generated interfaces in other languages.

An in-range update of @types/node is breaking the build 🚨

The devDependency @types/node was updated from 12.11.6 to 12.11.7.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of @types/node is breaking the build 🚨


🚨 Reminder! Less than one month left to migrate your repositories over to Snyk before Greenkeeper says goodbye on June 3rd! πŸ’œ πŸššπŸ’¨ πŸ’š

Find out how to migrate to Snyk at greenkeeper.io


The devDependency @types/node was updated from 13.13.4 to 13.13.5.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/node is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

We have a lot of property overrides in the code which are used only for documentation purposes

From @sichvoge comment to PR

Method: Actually inherits all properties from MethodBase which inherits its properties from >HasNormalParameters. But again I am seeing a lot properties that has been defined explicitly. BTW, >HasNormalParameters is really not a good name.

This is because Konst was overriding property descriptions for subtypes (same in all related cases). I am removing this overrides when I see them now.

I am removing this override as soon as I see them right now, but we need to invent some way of customising documentation in sub types.

We should think about removing `MethodBase` and `ResourceBase` classes

MethodBase, Method, Trait: Should that class not inherit all its properties from Method. As per the spec >there should not be any difference, accept that Trait has an additional usage property. Don't really see >why we would need MethodBase anymore.

ResourceBase, Resource, ResourceType: Same as my previous points; do we really need >ResourceBase. As per spec, ResourceType should also be a resource and hence inherit all its >properties plus define an additional usage property.

The need for separation in this case is caused by different restriction on the keys (for example Trait can have any name, but Method keys are restricted to valid http method names. (same about Resource and ResourceType. But in fact we may think about different representation for this.

An in-range update of rimraf is breaking the build 🚨

The devDependency rimraf was updated from 2.6.3 to 2.7.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

rimraf is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

Commits

The new version differs by 2 commits.

  • 250ee15 2.7.0
  • dc1682d feat: make it possible to omit glob dependency

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Question about example and examples

Looking at TypeDeclaration I can see two methods: example and structuredExample.

  1. What is the difference between those two?

  2. Where is examples?

Rename HasNormalParameters

Can we rename that class; it does not really say anything. What are normal parameters etc. What about just saying HasParameters?

In RC2, scalars can have annotations, so annotations property falls out of definition system

In RC2, even scalars can have annotations, so annotations property falls out of definition system

SecuritySchemeSettings: Do we not support any annotations for that? I can see >SecuritySchemeSettings: as target inside the annotation target table

We can not use RAMLLanguageElement as a sign that element may have annotations any more, so we should invent a new way of handling this.

An in-range update of @types/underscore is breaking the build 🚨


☝️ Important announcement: Greenkeeper will be saying goodbye πŸ‘‹ and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io


The devDependency @types/underscore was updated from 1.9.4 to 1.10.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

@types/underscore is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of underscore is breaking the build 🚨


☝️ Important announcement: Greenkeeper will be saying goodbye πŸ‘‹ and passing the torch to Snyk on June 3rd, 2020! Find out how to migrate to Snyk and more at greenkeeper.io


The dependency underscore was updated from 1.9.2 to 1.10.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

underscore is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details
  • ❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Commits

The new version differs by 46 commits.

  • 985fce6 Underscore.js v1.10.0
  • fa2c1f8 Merge pull request #2834 from jashkenas/prepare-1.10
  • e8da73c Add source map of the uncompressed UMD bundle to the publication files
  • 44cfe25 Update the license date range
  • 6b09e0e Remove the context parameter from the rollup config
  • accd8b1 Add link to source map of uncompressed UMD bundle in Download section
  • 7b32e0b Update the weight in the Downloads section
  • e1a5518 Bump the version number in the documentation and source code
  • d18f67f Mention the removal of Component support
  • 361a352 Include #2826 in the changelog, installation and noConflict sections
  • 948f3c9 Include #2831 in the changelog and the installation section
  • 5a4d81f Include #2829 in the changelog
  • c92e961 Include #2825 in the changelog
  • 4990d19 Include #2820 in the changelog
  • 2552702 Fix the documentation link of the previous changelog entry

There are 46 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.