Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Commit

Permalink
Merge pull request #105 from raml-org/sichvoge/tags-standards
Browse files Browse the repository at this point in the history
added tags thats been used so far
  • Loading branch information
sichvoge authored Feb 12, 2017
2 parents 417262b + 5c82000 commit a2382a7
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Test cases must be put under the `tests` directory by either putting your tests

For more information, please have a look at [this example](tests/raml-1.0/spec-examples/APIs/additional-facets-single-example.raml).

For more information what tags to use, please see a list of commonly used inside [common-tags.md](common-tags.md). You can suggest new by raising an issue within this repository.

Each test needs to have a TCK specific file that will be actually used as a comparison for the output of your parsing. You can create a TCK JSON file manually from scratch, and name it `<my API RAML file name>-tck.json`), or use the generate script provided inside the `src` directory. For example, you create a folder inside the `tests/raml-1.0/Traits` directory called `myTests` where you put all your tests files. Now, you only need to go to your terminal and execute the following:

Install dependencies
Expand Down
68 changes: 68 additions & 0 deletions common-tags.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
TCK tags:

```
facet
example
type
type expression
object
property
additional property
pattern property
annotation
scalar node
allowed target
trait
resource type
default media type
media type
security scheme
array
syntactic sugar
base uri
template uri
parameter
resource
uri parameter
external schema
http method
header
date-only
time-only
datetime-only
datetime
rfc3339
rfc2616
security
default security
default type
any
body
uri
resource
extension
file
fragment
inline
discriminator
annotation
library
example
multiple example
multiple inheritance
query parameter
strict
query string
union type
function
response
http code
external
fragment
x-other
oauth-1.0
oauth-2.0
digest
basic
xml facet
```

0 comments on commit a2382a7

Please sign in to comment.