Skip to content

Commit

Permalink
feat: update rule creation docs with org.zalando (#1337)
Browse files Browse the repository at this point in the history
  • Loading branch information
tkrop committed Jan 3, 2022
1 parent aa5b0b2 commit e730551
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions documentation/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ compliance requirements).
*Example*: "Zalando Rule Set" which verifies API's compliance to
[Zalando's API Guidelines](https://opensource.zalando.com/restful-api-guidelines/).

*Implementation*: [`package de.zalando.zally.rule.zalando`](../server/src/main/java/de/zalando/zally/rule/zalando)
*Implementation*: [`package org.zalando.zally.rule.zalando`](../server/src/main/java/org/zalando/zally/rule/zalando)

## Rule

Expand All @@ -18,7 +18,7 @@ automatically checked.

*Example*: "Use standardized HTTP response codes"

*Implementation*: [`UseStandardHttpStatusCodesRule.kt`](../server/src/main/java/de/zalando/zally/rule/zalando/UseStandardHttpStatusCodesRule.kt)
*Implementation*: [`UseStandardHttpStatusCodesRule.kt`](../server/src/main/java/org/zalando/zally/rule/zalando/UseStandardHttpStatusCodesRule.kt)

```Kotlin
@Rule(
Expand Down
20 changes: 10 additions & 10 deletions documentation/rule-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
In the following snippet you find a basic check implementation:

```Kotlin
package de.zalando.zally.rule.nicecompany
package org.zalando.zally.rule.nicecompany

import de.zalando.zally.rule.api.Check
import de.zalando.zally.rule.api.Context
import de.zalando.zally.rule.api.Rule
import de.zalando.zally.rule.api.Severity
import de.zalando.zally.rule.api.Violation
import org.zalando.zally.rule.api.Check
import org.zalando.zally.rule.api.Context
import org.zalando.zally.rule.api.Rule
import org.zalando.zally.rule.api.Severity
import org.zalando.zally.rule.api.Violation

@Rule(
ruleSet = NiceCompanyRuleSet::class,
Expand All @@ -38,10 +38,10 @@ or a `List` of `Violations`.
The check references to `NiceCompanyRuleSet`:

```Kotlin
package de.zalando.zally.rule.zalando
package org.zalando.zally.rule.zalando

import de.zalando.zally.core.AbstractRuleSet
import de.zalando.zally.rule.api.Rule
import org.zalando.zally.core.AbstractRuleSet
import org.zalando.zally.rule.api.Rule
import org.springframework.stereotype.Component
import java.net.URI

Expand Down Expand Up @@ -79,7 +79,7 @@ Here are some examples:
- `Context#validatePaths(pathFilter, action): List<Violation>`
- `Context#validateOperations(pathFilter, operationFilter, action): List<Violation>`

See [`DefaultContext`](../server/src/main/java/de/zalando/zally/rule/DefaultContext.kt)
See [`DefaultContext`](../server/src/main/java/org/zalando/zally/rule/DefaultContext.kt)
for more information.

## Create a violation
Expand Down

0 comments on commit e730551

Please sign in to comment.